Annotation Type Key (2.0.0)

Version latest

• 2.0.0 (latest)
• 1.47.1
• 1.46.3
• 1.45.3
• 1.44.2
• 1.43.2
• 1.42.3
• 1.41.8

public interface Key implements Annotation

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 specified, the default is the Java 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 dataKeyNameIsOverridden;

 // not a data key
 private String notADataKey;
 }
 

Implements

Annotation

Methods

value()

public abstract String value()

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

Returns
Type	Description
String