com.kabira.platform.annotation

Annotation Type Key

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Key

This annotation defines a single key for a Managed class.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	fields An ordered list of the fields that make up this key.
java.lang.String	name The name of this key on the given type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	mutable If true, the key fields can be updated.
boolean	ordered If true, the key data will be managed as an ordered set.
boolean	unique If true, the runtime will enforce that only one instance will contain the key data.

Element Detail

name

public abstract java.lang.String name

The name of this key on the given type. Key names must be unique for a single type (including inherited keys).

Returns:

String

fields

public abstract java.lang.String[] fields

An ordered list of the fields that make up this key. The fields must be defined in this class or in a superclass.

Returns:

String[]

unique

public abstract boolean unique

If true, the runtime will enforce that only one instance will contain the key data.

Returns:

boolean

Default:

true

ordered

public abstract boolean ordered

If true, the key data will be managed as an ordered set.

Returns:

boolean

Default:

false

mutable

public abstract boolean mutable

If true, the key fields can be updated.

Returns:

boolean

See Also:

KeyManager.updateIndexes(Object)

Default:

false