net.java.html.json

Annotation Type Property

@Retention(value=SOURCE)
 @Target(value={})
public @interface Property

Represents a property in a class defined with Model annotation.

Author:

Jaroslav Tulach

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Name of the property.
Class<?>	type Type of the property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	array Is this property an array of the Property.type() or a single value?
boolean	mutable Can the value of the property be mutated without restriction or not.

Element Detail

name

public abstract String name

Name of the property. Will be used to define proper getter and setter in the associated class.

Returns:

valid java identifier

type

public abstract Class<?> type

Type of the property. Can either be primitive type (like int.class, double.class, etc.), String, enum or complex model class (defined by Model property).

Returns:

the class of the property

array

public abstract boolean array

Is this property an array of the Property.type() or a single value? If the property is an array, only its getter (returning mutable List of the boxed Property.type()) is generated.

Returns:

true, if this property is supposed to represent an array of values

Default:

false

mutable

public abstract boolean mutable

Can the value of the property be mutated without restriction or not. If a property is defined as not mutable, it defines semi-immutable value that can only be changed in construction time before the object is passed to underlying Technology. Attempts to modify the object later yield IllegalStateException. Technologies may decide to represent such non-mutable property in more effective way - for example Knockout Java Bindings technology (with id "ko4j") uses plain JavaScript value (number, string, array, boolean) rather than classical observable.

Returns:

false if the value cannot change after its first use

Since:

1.3

Default:

true