BsonPersistentEntityCodec (GORM for MongoDB

org.grails.datastore.bson.codecs.BsonPersistentEntityCodec

All Implemented Interfaces and Traits:

Codec
```
@groovy.transform.CompileStatic
class BsonPersistentEntityCodec
extends java.lang.Object
implements Codec
```
Encodes and decodes PersistentEntity objects from a BSON stream
Authors:
Graeme Rocher
Since:
6.0

Field Summary

Fields
Modifiers	Name	Description
`static DecoderContext`	`DEFAULT_DECODER_CONTEXT`
`static EncoderContext`	`DEFAULT_ENCODER_CONTEXT`

Properties Summary

Properties
Type	Name and description
`CodecRegistry`	`codecRegistry`
`PersistentEntity`	`entity`
`MappingContext`	`mappingContext`
`boolean`	`stateful`

Constructor Summary

Constructors
Constructor and description
`BsonPersistentEntityCodec (CodecRegistry codecRegistry, PersistentEntity entity, boolean stateful)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`beforeFinishDocument(BsonWriter bsonWriter, EntityAccess access)` Called directly before the last call to finish the document writing process
	`protected EntityAccess`	`createEntityAccess(java.lang.Object instance)`
	`protected EntityAccess`	`createEntityAccess(PersistentEntity entity, java.lang.Object instance)`
	`java.lang.Object`	`decode(BsonReader bsonReader, DecoderContext decoderContext)`
	`void`	`encode(BsonWriter writer, java.lang.Object value, EncoderContext encoderContext)`
	`void`	`encode(BsonWriter writer, java.lang.Object value, EncoderContext encoderContext, boolean includeIdentifier)`
	`Bson`	`encodeUpdate(java.lang.Object value, EntityAccess access, EncoderContext encoderContext, boolean embedded)` This method will encode an update for the given object based
	`protected java.lang.String`	`getDiscriminatorAttributeName()` Returns: The name of the discriminator
	`java.lang.Class`	`getEncoderClass()`
`<T extends PersistentProperty>`	`protected PropertyDecoder<T>`	`getPropertyDecoder(java.lang.Class<T> type)` Obtains the property encoder for the given property type
`<T extends PersistentProperty>`	`protected PropertyEncoder<T>`	`getPropertyEncoder(java.lang.Class<T> type)` Obtains the property encoder for the given property type
	`protected boolean`	`isDiscriminatorProperty(java.lang.String name)`
	`protected boolean`	`isIdentifierProperty(java.lang.String name)` Whether the given document attribute is the identifier
	`protected void`	`readSchemaless(BsonReader bsonReader, DynamicAttributes dynamicAttributes, java.lang.String name, DecoderContext decoderContext)` Reads an undeclared property
	`protected void`	`readingComplete(EntityAccess access)` Called when reading from a BsonReader is completed
	`static void`	`registerDecoder(java.lang.Class<? extends PersistentProperty> type, PropertyDecoder propertyDecoder)`
	`static void`	`registerEncoder(java.lang.Class<? extends PersistentProperty> type, PropertyEncoder propertyEncoder)`
	`protected java.lang.Object`	`retrieveCachedInstance(EntityAccess access)` Retrieve a cached instance if any
	`protected void`	`writeAttributes(java.util.Map<java.lang.String, java.lang.Object> attributes, BsonWriter writer, EncoderContext encoderContext)` Writes the dynamic attributes to the writer
	`protected void`	`writingComplete(EntityAccess entityAccess)` Called when the document is fully written from the source entity

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final DecoderContext DEFAULT_DECODER_CONTEXT
  - public static final EncoderContext DEFAULT_ENCODER_CONTEXT
- Property Detail
  - final CodecRegistry codecRegistry
  - final PersistentEntity entity
  - final MappingContext mappingContext
  - final boolean stateful
- Constructor Detail
  - BsonPersistentEntityCodec(CodecRegistry codecRegistry, PersistentEntity entity, boolean stateful)
- Method Detail
  - protected void beforeFinishDocument(BsonWriter bsonWriter, EntityAccess access)
    
    Called directly before the last call to finish the document writing process
    Parameters:
    bsonWriter - The BsonWriter
    access - The entity access
  - protected EntityAccess createEntityAccess(java.lang.Object instance)
  - protected EntityAccess createEntityAccess(PersistentEntity entity, java.lang.Object instance)
  - @java.lang.Override java.lang.Object decode(BsonReader bsonReader, DecoderContext decoderContext)
  - @java.lang.Override void encode(BsonWriter writer, java.lang.Object value, EncoderContext encoderContext)
  - void encode(BsonWriter writer, java.lang.Object value, EncoderContext encoderContext, boolean includeIdentifier)
  - Bson encodeUpdate(java.lang.Object value, EntityAccess access, EncoderContext encoderContext, boolean embedded)
    
    This method will encode an update for the given object based
    Parameters:
    value - A org.bson.conversions.Bson that is the update object
    Returns:
    A Bson
  - protected java.lang.String getDiscriminatorAttributeName()
    
    Returns:
    The name of the discriminator
  - @java.lang.Override java.lang.Class getEncoderClass()
  - <T extends PersistentProperty> protected PropertyDecoder<T> getPropertyDecoder(java.lang.Class<T> type)
    
    Obtains the property encoder for the given property type
    Parameters:
    type - The property encoder type
    Returns:
    The encoder or null if it doesn't exist
  - <T extends PersistentProperty> protected PropertyEncoder<T> getPropertyEncoder(java.lang.Class<T> type)
    
    Obtains the property encoder for the given property type
    Parameters:
    type - The property encoder type
    Returns:
    The encoder or null if it doesn't exist
  - protected boolean isDiscriminatorProperty(java.lang.String name)
  - protected boolean isIdentifierProperty(java.lang.String name)
    
    Whether the given document attribute is the identifier
    Parameters:
    name - The name of the document attribute
    Returns:
    True if it is an identifier
  - protected void readSchemaless(BsonReader bsonReader, DynamicAttributes dynamicAttributes, java.lang.String name, DecoderContext decoderContext)
    
    Reads an undeclared property
    Parameters:
    bsonReader - The bson reader
    dynamicAttributes - a document of undeclared properties
    name
    decoderContext
  - protected void readingComplete(EntityAccess access)
    
    Called when reading from a BsonReader is completed
    Parameters:
    access - the access
  - static void registerDecoder(java.lang.Class<? extends PersistentProperty> type, PropertyDecoder propertyDecoder)
  - static void registerEncoder(java.lang.Class<? extends PersistentProperty> type, PropertyEncoder propertyEncoder)
  - protected java.lang.Object retrieveCachedInstance(EntityAccess access)
    
    Retrieve a cached instance if any
    Parameters:
    access - The entity access
    Returns:
    A cached instance
  - protected void writeAttributes(java.util.Map<java.lang.String, java.lang.Object> attributes, BsonWriter writer, EncoderContext encoderContext)
    
    Writes the dynamic attributes to the writer
    Parameters:
    attributes - The dynamic attributes
    writer - The writer
    encoderContext
  - protected void writingComplete(EntityAccess entityAccess)
    
    Called when the document is fully written from the source entity
    Parameters:
    entityAccess - Access to the entity

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class BsonPersistentEntityCodec

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final DecoderContext DEFAULT_DECODER_CONTEXT

public static final EncoderContext DEFAULT_ENCODER_CONTEXT

Property Detail

final CodecRegistry codecRegistry

final PersistentEntity entity

final MappingContext mappingContext

final boolean stateful

Constructor Detail

BsonPersistentEntityCodec(CodecRegistry codecRegistry, PersistentEntity entity, boolean stateful)

Method Detail

protected void beforeFinishDocument(BsonWriter bsonWriter, EntityAccess access)

protected EntityAccess createEntityAccess(java.lang.Object instance)

protected EntityAccess createEntityAccess(PersistentEntity entity, java.lang.Object instance)

@java.lang.Override java.lang.Object decode(BsonReader bsonReader, DecoderContext decoderContext)

@java.lang.Override void encode(BsonWriter writer, java.lang.Object value, EncoderContext encoderContext)

void encode(BsonWriter writer, java.lang.Object value, EncoderContext encoderContext, boolean includeIdentifier)

Bson encodeUpdate(java.lang.Object value, EntityAccess access, EncoderContext encoderContext, boolean embedded)

protected java.lang.String getDiscriminatorAttributeName()

@java.lang.Override java.lang.Class getEncoderClass()

<T extends PersistentProperty> protected PropertyDecoder<T> getPropertyDecoder(java.lang.Class<T> type)

<T extends PersistentProperty> protected PropertyEncoder<T> getPropertyEncoder(java.lang.Class<T> type)

protected boolean isDiscriminatorProperty(java.lang.String name)

protected boolean isIdentifierProperty(java.lang.String name)

protected void readSchemaless(BsonReader bsonReader, DynamicAttributes dynamicAttributes, java.lang.String name, DecoderContext decoderContext)

protected void readingComplete(EntityAccess access)

static void registerDecoder(java.lang.Class<? extends PersistentProperty> type, PropertyDecoder propertyDecoder)

static void registerEncoder(java.lang.Class<? extends PersistentProperty> type, PropertyEncoder propertyEncoder)

protected java.lang.Object retrieveCachedInstance(EntityAccess access)

protected void writeAttributes(java.util.Map<java.lang.String, java.lang.Object> attributes, BsonWriter writer, EncoderContext encoderContext)

protected void writingComplete(EntityAccess entityAccess)