com.jsoniter.annotation

Annotation Type JsonProperty

@Target(value={ANNOTATION_TYPE,FIELD,METHOD,PARAMETER})
 @Retention(value=RUNTIME)
public @interface JsonProperty

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	collectionValueNullable
Class<? extends Decoder>	decoder
String	defaultValueToOmit
Class<? extends Encoder>	encoder
String[]	from
Class<?>	implementation
boolean	nullable
boolean	required
String[]	to
String	value

Element Detail

value

public abstract String value

Returns:

alternative name for the field/getter/setter/parameter

Default:

""

from

public abstract String[] from

Returns:

when bind from multiple possible names, set this

Default:

{}

to

public abstract String[] to

Returns:

when one field will write to multiple object fields, set this

Default:

{}

required

public abstract boolean required

Returns:

used in decoding only, the field must present in the JSON, regardless null or not

Default:

false

decoder

public abstract Class<? extends Decoder> decoder

Returns:

set different decoder just for this field

Default:

com.jsoniter.spi.Decoder.class

implementation

public abstract Class<?> implementation

Returns:

used in decoding only, choose concrete class for interface/abstract type

Default:

java.lang.Object.class

encoder

public abstract Class<? extends Encoder> encoder

Returns:

set different encoder just for this field

Default:

com.jsoniter.spi.Encoder.class

nullable

public abstract boolean nullable

Returns:

used in encoding only, should check null for this field, skip null checking will make encoding faster

Default:

true

collectionValueNullable

public abstract boolean collectionValueNullable

Returns:

used in encoding only, should check null for the value, if it is collection, skip null checking will make encoding faster

Default:

true

defaultValueToOmit

public abstract String defaultValueToOmit

Returns:

the default value to omit null, to omit null value \"xxx\", to omit string value 123, to omit number void, to always encode this field, ignore global config

Default:

""