Package org.eclipse.yasson.internal.model

Class PropertyModel

java.lang.Object

org.eclipse.yasson.internal.model.PropertyModel

All Implemented Interfaces:

Comparable<PropertyModel>, JsonBindingModel

public class PropertyModel
extends Object
implements JsonBindingModel, Comparable<PropertyModel>

A model for class property. Property is JavaBean alike meta information field / getter / setter of a property in class.

Author:

Dmitry Kornilov, Roman Grigoriadi

Constructor Summary

Constructors

Constructor	Description
PropertyModel(ClassModel classModel, Property property, JsonbContext jsonbContext)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PropertyModel o)
boolean	equals(Object o)
ClassModel	getClassModel()	Model of declaring class of this property.
JsonContext	getContext()	Current context of json generator.
PropertyCustomization	getCustomization()	Introspected customization of a property.
PropertyValuePropagation	getPropagation()	Wrapper object of java.lang.reflect representations of this javabean property.
String	getPropertyName()	Default property name according to Field / Getter / Setter method names.
javax.json.bind.serializer.JsonbSerializer<?>	getPropertySerializer()	Gets serializer.
Type	getPropertyType()	Runtime type of a property.
String	getReadName()	Gets a name of JSON document property to read this property from.
Type	getType()	Class of a property, either bean property type or collection / array component type.
Object	getValue(Object object)	Read a property.
String	getWriteName()	Returns a name of json key that will be written by marshaller.
int	hashCode()
boolean	isReadable()	Property is readable.
boolean	isWritable()	Property is writable.
void	setValue(Object object, Object value)	Sets a property.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyModel

public PropertyModel(ClassModel classModel,
                     Property property,
                     JsonbContext jsonbContext)

Creates an instance.

Parameters:

classModel - Class model of declaring class.

property - Property.

jsonbContext - Context.

Method Detail

getValue

public Object getValue(Object object)

Read a property.

Parameters:

object - object to read property from.

Returns:

value in case property value is set and field is readable. If null or not readable (transient, static), return s null.

setValue

public void setValue(Object object,
                     Object value)

Sets a property. If not writable (final, transient, static), ignores property.

Parameters:

object - Object to set value in.

value - Value to set.

isReadable

public boolean isReadable()

Property is readable. Based on access policy and java field modifiers.

Returns:

true if can be serialized to JSON

isWritable

public boolean isWritable()

Property is writable. Based on access policy and java field modifiers.

Returns:

true if can be deserialized from JSON

getPropertyName

public String getPropertyName()

Default property name according to Field / Getter / Setter method names. This name is use for identifying properties, for JSON serialization is used customized name which may be derived from default name.

Returns:

default name

getPropertyType

public Type getPropertyType()

Runtime type of a property. May be a TypeVariable or WildcardType.

Returns:

type of a property

getClassModel

public ClassModel getClassModel()

Model of declaring class of this property.

Returns:

class model

getCustomization

public PropertyCustomization getCustomization()

Introspected customization of a property.

Specified by:

getCustomization in interface JsonBindingModel

Returns:

immutable property customization

getType

public Type getType()

Class of a property, either bean property type or collection / array component type.

Specified by:

getType in interface JsonBindingModel

Returns:

class type

compareTo

public int compareTo(PropertyModel o)

Specified by:

compareTo in interface Comparable<PropertyModel>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getContext

public JsonContext getContext()

Description copied from interface: JsonBindingModel

Current context of json generator.

Specified by:

getContext in interface JsonBindingModel

Returns:

context

getReadName

public String getReadName()

Gets a name of JSON document property to read this property from.

Returns:

Name of JSON document property.

getWriteName

public String getWriteName()

Description copied from interface: JsonBindingModel

Returns a name of json key that will be written by marshaller.

Specified by:

getWriteName in interface JsonBindingModel

Returns:

name of json key

getPropertySerializer

public javax.json.bind.serializer.JsonbSerializer<?> getPropertySerializer()

Gets serializer.

Returns:

Serializer.

getPropagation

public PropertyValuePropagation getPropagation()

Wrapper object of java.lang.reflect representations of this javabean property.

Returns:

Property model