Package org.bson.codecs.pojo
Class PropertyModelBuilder<T>
-
- org.bson.codecs.pojo.PropertyModelBuilder<T>
-
- Type Parameters:
T
- the type of the property
public final class PropertyModelBuilder<T> extends
A builder for programmatically creatingPropertyModels
.- Since:
- 3.5
- See Also:
PropertyModel
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PropertyModel<T>
build()
Creates thePropertyModel
.PropertyModelBuilder<T>
codec(Codec<T> codec)
Sets a custom codec for the propertyPropertyModelBuilder<T>
discriminatorEnabled(boolean discriminatorEnabled)
Enables or disables the use of a discriminator when serializinggetName()
PropertyAccessor<T>
getPropertyAccessor()
Returns thePropertyAccessor
PropertySerialization<T>
getPropertySerialization()
<>
getReadAnnotations()
Returns the read annotations, to be applied when serializing to BSONgetReadName()
<>
getWriteAnnotations()
Returns the write annotations, to be applied when deserializing from BSONgetWriteName()
isDiscriminatorEnabled()
boolean
isReadable()
Property is readable.boolean
isWritable()
Property is writable.PropertyModelBuilder<T>
propertyAccessor(PropertyAccessor<T> propertyAccessor)
Sets thePropertyAccessor
PropertyModelBuilder<T>
propertySerialization(PropertySerialization<T> propertySerialization)
Sets thePropertySerialization
checkerPropertyModelBuilder<T>
<> annotations)
Sets the read annotations, to be applied when serializing to BSONPropertyModelBuilder<T>
readName)
Sets the readName, the key for this property when deserializing the data from BSON.toString()
PropertyModelBuilder<T>
<> writeAnnotations)
Sets the writeAnnotations, to be applied when deserializing from BSONPropertyModelBuilder<T>
writeName)
Sets the writeName, the key for this property when serializing the data into BSON.
-
-
-
Method Detail
-
getName
public getName()
- Returns:
- the property name
-
getReadName
public getReadName()
- Returns:
- the name of the property to use as the key when deserializing the data from BSON.
-
readName
public readName)
Sets the readName, the key for this property when deserializing the data from BSON.Note: A null means this property will not used when deserializing.
- Parameters:
readName
- the name of the property to use as the key when deserializing the data from BSON.- Returns:
- this
-
getWriteName
public getWriteName()
- Returns:
- the name of the property to use as the key when serializing the data into BSON.
-
writeName
public writeName)
Sets the writeName, the key for this property when serializing the data into BSON.Note: A null means this property will not be serialized.
- Parameters:
writeName
- the name of the property to use as the key when serializing the data into BSON.- Returns:
- this
-
codec
public PropertyModelBuilder<T> codec(Codec<T> codec)
Sets a custom codec for the property- Parameters:
codec
- the custom codec for the property- Returns:
- this
-
propertySerialization
public PropertyModelBuilder<T> propertySerialization(PropertySerialization<T> propertySerialization)
Sets thePropertySerialization
checker- Parameters:
propertySerialization
- checks if a property should be serialized- Returns:
- this
-
getPropertySerialization
public PropertySerialization<T> getPropertySerialization()
- Returns:
- the
PropertySerialization
checker
-
getReadAnnotations
public <> getReadAnnotations()
Returns the read annotations, to be applied when serializing to BSON- Returns:
- the read annotations
-
readAnnotations
public <> annotations)
Sets the read annotations, to be applied when serializing to BSON- Parameters:
annotations
- the read annotations- Returns:
- this
-
getWriteAnnotations
public <> getWriteAnnotations()
Returns the write annotations, to be applied when deserializing from BSON- Returns:
- the write annotations
-
writeAnnotations
public <> writeAnnotations)
Sets the writeAnnotations, to be applied when deserializing from BSON- Parameters:
writeAnnotations
- the writeAnnotations- Returns:
- this
-
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
-
isDiscriminatorEnabled
public isDiscriminatorEnabled()
- Returns:
- true or false if a discriminator should be used when serializing or null if not set
-
discriminatorEnabled
public PropertyModelBuilder<T> discriminatorEnabled(boolean discriminatorEnabled)
Enables or disables the use of a discriminator when serializing- Parameters:
discriminatorEnabled
- the useDiscriminator value- Returns:
- this
-
getPropertyAccessor
public PropertyAccessor<T> getPropertyAccessor()
Returns thePropertyAccessor
- Returns:
- the PropertyAccessor
-
propertyAccessor
public PropertyModelBuilder<T> propertyAccessor(PropertyAccessor<T> propertyAccessor)
Sets thePropertyAccessor
- Parameters:
propertyAccessor
- the PropertyAccessor- Returns:
- this
-
build
public PropertyModel<T> build()
Creates thePropertyModel
.- Returns:
- the PropertyModel
-
toString
public toString()
- Overrides:
in class
-
-