com.owlike.genson.annotation

Annotation Type JsonProperty

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

JsonProperty annotation can be used to define the name of a property. You can apply it on fields and methods. In that case this name will be used instead of the conventional one computed from the signature. You can also use this annotation on parameters of creator methods and on constructor parameters. In that case Genson during deserialization will try to use those names to match the properties from the json stream. By default it is used in AnnotationPropertyNameResolver.

Author:

eugen

See Also:

AnnotationPropertyNameResolver, JsonCreator, JsonIgnore

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	aliases A list of aliases to use during deserialization for this property.
boolean	deserialize Whether this property must be deserialized.
boolean	serialize Whether this property must be serialized.
String	value The name of that property.

Element Detail

value

public abstract String value

The name of that property.

Default:

""

aliases

public abstract String[] aliases

A list of aliases to use during deserialization for this property. Note that during serialization this is not used.

Default:

{}

serialize

public abstract boolean serialize

Whether this property must be serialized. Default is true, the property will be serialized.

Default:

true

deserialize

public abstract boolean deserialize

Whether this property must be deserialized. Default is true, the property will be deserialized.

Default:

true