Package dev.morphia.mapping.codec.writer

Class DocumentWriter

java.lang.Object

dev.morphia.mapping.codec.writer.DocumentWriter

All Implemented Interfaces:

BsonWriter

@MorphiaInternal
public class DocumentWriter
extends Object
implements BsonWriter

Utility to write out to a Document

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

Constructor Summary

Constructors

Constructor	Description
DocumentWriter(Mapper mapper)	Creates a new Writer
DocumentWriter(Mapper mapper, Document seed)	Creates a new Writer with a seeded Document

Method Summary

Modifier and Type	Method	Description
static Document	encode(Object value, Mapper mapper, CodecRegistry codecRegistry)	Encodes a value.
static Document	encode(Object value, Mapper mapper, CodecRegistry codecRegistry, EncoderContext encoderContext)	Encodes this writer's structuring using the given codec
DocumentWriter	encode(CodecRegistry codecRegistry, Object value, EncoderContext encoderContext)	Encodes a value in to this Writer
void	flush()
Document	getDocument()
void	pipe(BsonReader reader)
dev.morphia.mapping.codec.writer.WriteState	state()
String	toString()
void	writeBinaryData(String name, BsonBinary binary)
void	writeBinaryData(BsonBinary binary)
void	writeBoolean(boolean value)
void	writeBoolean(String name, boolean value)
void	writeDateTime(long value)
void	writeDateTime(String name, long value)
void	writeDBPointer(String name, BsonDbPointer value)
void	writeDBPointer(BsonDbPointer value)
void	writeDecimal128(String name, Decimal128 value)
void	writeDecimal128(Decimal128 value)
void	writeDouble(double value)
void	writeDouble(String name, double value)
void	writeEndArray()
void	writeEndDocument()
void	writeInt32(int value)
void	writeInt32(String name, int value)
void	writeInt64(long value)
void	writeInt64(String name, long value)
void	writeJavaScript(String code)
void	writeJavaScript(String name, String code)
void	writeJavaScriptWithScope(String code)
void	writeJavaScriptWithScope(String name, String code)
void	writeMaxKey()
void	writeMaxKey(String name)
void	writeMinKey()
void	writeMinKey(String name)
void	writeName(String name)
void	writeNull()
void	writeNull(String name)
void	writeObjectId(String name, ObjectId objectId)
void	writeObjectId(ObjectId objectId)
void	writeRegularExpression(String name, BsonRegularExpression regularExpression)
void	writeRegularExpression(BsonRegularExpression regularExpression)
void	writeStartArray()
void	writeStartArray(String name)
void	writeStartDocument()
void	writeStartDocument(String name)
void	writeString(String value)
void	writeString(String name, String value)
void	writeSymbol(String value)
void	writeSymbol(String name, String value)
void	writeTimestamp(String name, BsonTimestamp value)
void	writeTimestamp(BsonTimestamp value)
void	writeUndefined()
void	writeUndefined(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentWriter

public DocumentWriter(Mapper mapper)

Creates a new Writer

Parameters:

mapper - the mapper to use

DocumentWriter

public DocumentWriter(Mapper mapper,
                      Document seed)

Creates a new Writer with a seeded Document

Parameters:

mapper - the mapper to use

seed - the seed Document

Method Detail

encode

public DocumentWriter encode(CodecRegistry codecRegistry,
                             Object value,
                             EncoderContext encoderContext)

Encodes a value in to this Writer

Parameters:

codecRegistry - the registry to use

value - the value to encode

encoderContext - the context

Returns:

this

encode

public static Document encode(Object value,
                              Mapper mapper,
                              CodecRegistry codecRegistry)

Encodes a value.

Parameters:

value - the value to encode

mapper -

codecRegistry -

Returns:

the encoded Document

encode

public static Document encode(Object value,
                              Mapper mapper,
                              CodecRegistry codecRegistry,
                              EncoderContext encoderContext)

Encodes this writer's structuring using the given codec

Parameters:

value - the value to encode

mapper -

codecRegistry -

encoderContext - the encoder context

Returns:

the encoded Document

flush

public void flush()

Specified by:

flush in interface BsonWriter

getDocument

public Document getDocument()

Returns:

the root, or output, of this writer. usually a Document.

state

public dev.morphia.mapping.codec.writer.WriteState state()

Returns:

the state

writeBinaryData

public void writeBinaryData(BsonBinary binary)

Specified by:

writeBinaryData in interface BsonWriter

writeBinaryData

public void writeBinaryData(String name,
                            BsonBinary binary)

Specified by:

writeBinaryData in interface BsonWriter

writeBoolean

public void writeBoolean(boolean value)

Specified by:

writeBoolean in interface BsonWriter

writeBoolean

public void writeBoolean(String name,
                         boolean value)

Specified by:

writeBoolean in interface BsonWriter

writeDateTime

public void writeDateTime(long value)

Specified by:

writeDateTime in interface BsonWriter

writeDateTime

public void writeDateTime(String name,
                          long value)

Specified by:

writeDateTime in interface BsonWriter

writeDBPointer

public void writeDBPointer(BsonDbPointer value)

Specified by:

writeDBPointer in interface BsonWriter

writeDBPointer

public void writeDBPointer(String name,
                           BsonDbPointer value)

Specified by:

writeDBPointer in interface BsonWriter

writeDouble

public void writeDouble(double value)

Specified by:

writeDouble in interface BsonWriter

writeDouble

public void writeDouble(String name,
                        double value)

Specified by:

writeDouble in interface BsonWriter

writeEndArray

public void writeEndArray()

Specified by:

writeEndArray in interface BsonWriter

writeEndDocument

public void writeEndDocument()

Specified by:

writeEndDocument in interface BsonWriter

writeInt32

public void writeInt32(int value)

Specified by:

writeInt32 in interface BsonWriter

writeInt32

public void writeInt32(String name,
                       int value)

Specified by:

writeInt32 in interface BsonWriter

writeInt64

public void writeInt64(long value)

Specified by:

writeInt64 in interface BsonWriter

writeInt64

public void writeInt64(String name,
                       long value)

Specified by:

writeInt64 in interface BsonWriter

writeDecimal128

public void writeDecimal128(Decimal128 value)

Specified by:

writeDecimal128 in interface BsonWriter

writeDecimal128

public void writeDecimal128(String name,
                            Decimal128 value)

Specified by:

writeDecimal128 in interface BsonWriter

writeJavaScript

public void writeJavaScript(String code)

Specified by:

writeJavaScript in interface BsonWriter

writeMaxKey

public void writeMaxKey(String name)

Specified by:

writeMaxKey in interface BsonWriter

writeJavaScript

public void writeJavaScript(String name,
                            String code)

Specified by:

writeJavaScript in interface BsonWriter

writeMinKey

public void writeMinKey(String name)

Specified by:

writeMinKey in interface BsonWriter

writeJavaScriptWithScope

public void writeJavaScriptWithScope(String code)

Specified by:

writeJavaScriptWithScope in interface BsonWriter

writeJavaScriptWithScope

public void writeJavaScriptWithScope(String name,
                                     String code)

Specified by:

writeJavaScriptWithScope in interface BsonWriter

writeMaxKey

public void writeMaxKey()

Specified by:

writeMaxKey in interface BsonWriter

writeMinKey

public void writeMinKey()

Specified by:

writeMinKey in interface BsonWriter

writeName

public void writeName(String name)

Specified by:

writeName in interface BsonWriter

writeNull

public void writeNull()

Specified by:

writeNull in interface BsonWriter

writeNull

public void writeNull(String name)

Specified by:

writeNull in interface BsonWriter

writeObjectId

public void writeObjectId(ObjectId objectId)

Specified by:

writeObjectId in interface BsonWriter

writeStartArray

public void writeStartArray(String name)

Specified by:

writeStartArray in interface BsonWriter

writeObjectId

public void writeObjectId(String name,
                          ObjectId objectId)

Specified by:

writeObjectId in interface BsonWriter

writeRegularExpression

public void writeRegularExpression(BsonRegularExpression regularExpression)

Specified by:

writeRegularExpression in interface BsonWriter

writeRegularExpression

public void writeRegularExpression(String name,
                                   BsonRegularExpression regularExpression)

Specified by:

writeRegularExpression in interface BsonWriter

writeStartArray

public void writeStartArray()

Specified by:

writeStartArray in interface BsonWriter

writeStartDocument

public void writeStartDocument()

Specified by:

writeStartDocument in interface BsonWriter

writeSymbol

public void writeSymbol(String name,
                        String value)

Specified by:

writeSymbol in interface BsonWriter

writeStartDocument

public void writeStartDocument(String name)

Specified by:

writeStartDocument in interface BsonWriter

writeString

public void writeString(String value)

Specified by:

writeString in interface BsonWriter

writeString

public void writeString(String name,
                        String value)

Specified by:

writeString in interface BsonWriter

writeUndefined

public void writeUndefined(String name)

Specified by:

writeUndefined in interface BsonWriter

pipe

public void pipe(BsonReader reader)

Specified by:

pipe in interface BsonWriter

writeSymbol

public void writeSymbol(String value)

Specified by:

writeSymbol in interface BsonWriter

writeTimestamp

public void writeTimestamp(BsonTimestamp value)

Specified by:

writeTimestamp in interface BsonWriter

writeTimestamp

public void writeTimestamp(String name,
                           BsonTimestamp value)

Specified by:

writeTimestamp in interface BsonWriter

writeUndefined

public void writeUndefined()

Specified by:

writeUndefined in interface BsonWriter

toString

public String toString()

Overrides:

toString in class Object