com.google.api.client.util
Annotation Type Key

@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface Key

Use this annotation to specify that a field is a data key, optionally providing the data key name to use.

If the data key name is not specifies, the default data key name is the field's name. For example:

public class A {
 
   // uses data key name of "dataKeyNameMatchesFieldName" 
   @Key
   public String dataKeyNameMatchesFieldName;
   
   // uses data key name of "some_other_name"
   @Key("some_other_name") 
   private String dataKeyNameIsOverriden;
   
   // not a data key
   private String notADataKey; 
 }

Since:

1.0

Author:

Yaniv Inbar

Optional Element Summary

String

value Override the data key name of the field or "##default" to use the field's name.

value

public abstract String value

Override the data key name of the field or "##default" to use the field's name.

Default:

"##default"