Key (processor API)

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface Key

Field Summary

Fields
Modifier and Type	Fields and Description
`static java.lang.String`	`DEFAULT_NAME`
`static int`	`DEFAULT_PLACEHOLDER` Use a value of a field definition as a placeholder
`static int`	`GIVEN_PARAMETER` Use a given parameter as a placeholder
`static int`	`IMMEDIATE_CACHE` Do cache data from a data store in constructor first
`static int`	`LAZY_CACHE` Do cache data from a data store lazy
`static int`	`LOWER_CAMEL` Convert a field name to lower camel e.g.
`static int`	`LOWER_UNDERSCORE` Convert a field name to lower underscore e.g.
`static int`	`NO_CACHE` Always read data from a data store
`static int`	`NONE` Use a field name as it is
`static int`	`UPPER_CAMEL` Convert a field name to upper camel e.g.
`static int`	`UPPER_UNDERSCORE` Convert a field name to upper underscore e.g.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`int`	`cacheStrategy`
`java.lang.String`	`name` If you specify this, the value will be used for a key of a store.
`int`	`nameStrategy` Specify a name strategy to convert a key field name.
`int`	`placeholder`

- Field Detail
  - DEFAULT_NAME
```
public static final java.lang.String DEFAULT_NAME
```
    See Also:
    
    name()
- - NO_CACHE
```
public static final int NO_CACHE
```
    Always read data from a data store
- - LAZY_CACHE
```
public static final int LAZY_CACHE
```
    Do cache data from a data store lazy
- - IMMEDIATE_CACHE
```
public static final int IMMEDIATE_CACHE
```
    Do cache data from a data store in constructor first
- - NONE
```
public static final int NONE
```
    Use a field name as it is
- - LOWER_CAMEL
```
public static final int LOWER_CAMEL
```
    Convert a field name to lower camel e.g. lowerCamel
- - UPPER_CAMEL
```
public static final int UPPER_CAMEL
```
    Convert a field name to upper camel e.g. UpperCamel
- - LOWER_UNDERSCORE
```
public static final int LOWER_UNDERSCORE
```
    Convert a field name to lower underscore e.g. lower_underscore
- - UPPER_UNDERSCORE
```
public static final int UPPER_UNDERSCORE
```
    Convert a field name to upper underscore e.g. UPPER_UNDERSCORE
- - DEFAULT_PLACEHOLDER
```
public static final int DEFAULT_PLACEHOLDER
```
    Use a value of a field definition as a placeholder
- - GIVEN_PARAMETER
```
public static final int GIVEN_PARAMETER
```
    Use a given parameter as a placeholder
- Element Detail
  - name
```
public abstract java.lang.String name
```
    If you specify this, the value will be used for a key of a store. Otherwise, an element name which this annotates will be converted based on nameStrategy() and will be used for a key of a store.
    
    Returns:
    
    a name which you want to use or DEFAULT_NAME
    
    Default:
    
    "[element-name]"
- - cacheStrategy
```
public abstract int cacheStrategy
```
    Default:
    
    0
- - nameStrategy
```
public abstract int nameStrategy
```
    Specify a name strategy to convert a key field name. This won't be used unless name() equals DEFAULT_NAME
    
    Returns:
    
    see Key.NameStrategy
    
    Default:
    
    0
- - placeholder
```
public abstract int placeholder
```
    Default:
    
    0

Annotation Type Key

Field Summary

Optional Element Summary

Field Detail

DEFAULT_NAME

NO_CACHE

LAZY_CACHE

IMMEDIATE_CACHE

NONE

LOWER_CAMEL

UPPER_CAMEL

LOWER_UNDERSCORE

UPPER_UNDERSCORE

DEFAULT_PLACEHOLDER

GIVEN_PARAMETER

Element Detail

name

cacheStrategy

nameStrategy

placeholder