com.basho.riak.client.api.annotations

Annotation Type RiakUsermeta

@Retention(value=RUNTIME)
@Target(value={java.lang.annotation.ElementType.FIELD, java.lang.annotation.ElementType.METHOD})
public @interface RiakUsermeta

Annotates a field or getter/setter method pair in a class to serve as containing user meta data for a Riak object.

If you set the key value (to anything other than the empty string) then you can use the annotation to map a single key of user meta data to a field.

 public class MyClass 
 {
     
     @RiakUsermeta
     private Map<String, String> usermetaData;
     
     @RiakUsermeta("usermeta-data-key1") 
     private String usermetaDataItem1;
 }
 
 public class MyClass
 {
     private Map<String, String> usermetaData;
     private String usermetaDataItem1;
 
     @RiakUsermeta
     public Map<String, String> getMeta()
     {
         return usermetaData;
     }
 
     @RiakUsermeta
     public void setMeta(Map<String,String> meta)
     {
         usermetaData = meta;
     }
 
     @RiakUsermeta("usermeta-data-key1") 
     public String getSingleMeta()
     {
          return usermetaDataItem1;
     }
 
     @RiakUsermeta("usermeta-data-key1")
     public void setSingleMeta(String meta)
     {
         usermetaDataItem1 = meta;
     }
  }
 

Since:

1.0

Author:

Russel Brown , Brian Roach

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	key Use a lower case key.

Element Detail

key

public abstract String key

Use a lower case key. The riak HTTP API *will* lower case key names.

Returns:

the key for the user meta item

Default:

""