com.rt.storage.api.client.util.Key Maven / Gradle / Ivy
package com.rt.storage.api.client.util;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 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;
* }
*
*
* @since 1.0
* @author Yaniv Inbar
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Key {
/**
* Override the data key name of the field or {@code "##default"} to use the Java field's name.
*/
String value() default "##default";
}