Package org.bson.codecs.pojo

Class PropertyModel<T>

java.lang.Object

org.bson.codecs.pojo.PropertyModel<T>

Type Parameters:

T - the type of the property that the PropertyModel represents.

public final class PropertyModel<T>
extends Object

Represents a property on a class and stores various metadata such as generic parameters

Since:

3.5

Method Summary

Modifier and Type	Method	Description
static <T> PropertyModelBuilder<T>	builder()	Create a new PropertyModelBuilder
boolean	equals(Object o)
Codec<T>	getCodec()
String	getName()
PropertyAccessor<T>	getPropertyAccessor()
String	getReadName()
org.bson.codecs.pojo.TypeData<T>	getTypeData()
String	getWriteName()
int	hashCode()
boolean	isReadable()	Property is readable.
boolean	isWritable()	Property is writable.
boolean	shouldSerialize(T value)	Returns true if the value should be serialized.
String	toString()
Boolean	useDiscriminator()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <T> PropertyModelBuilder<T> builder()

Create a new PropertyModelBuilder

Type Parameters:

T - the type of the property

Returns:

the builder

getName

public String getName()

Returns:

the property name for the model

getWriteName

public String getWriteName()

Returns:

the name of the property to use as the key when deserializing from BSON

getReadName

public String getReadName()

Returns:

the name of the property to use as the key when serializing into BSON

isWritable

public boolean isWritable()

Property is writable.

Returns:

true if can be deserialized from BSON

isReadable

public boolean isReadable()

Property is readable.

Returns:

true if can be serialized to BSON

getTypeData

public org.bson.codecs.pojo.TypeData<T> getTypeData()

Returns:

the type data for the property

getCodec

public Codec<T> getCodec()

Returns:

the custom codec to use if set or null

shouldSerialize

public boolean shouldSerialize(T value)

Returns true if the value should be serialized.

Parameters:

value - the value to check

Returns:

true if the value should be serialized.

getPropertyAccessor

public PropertyAccessor<T> getPropertyAccessor()

Returns:

the property accessor

useDiscriminator

public Boolean useDiscriminator()

Returns:

true or false if a discriminator should be used when serializing or null if not set

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object