org.bson

类 BsonBinaryWriter

java.lang.Object

org.bson.AbstractBsonWriter

org.bson.BsonBinaryWriter

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, BsonWriter

public class BsonBinaryWriter
extends AbstractBsonWriter

A BsonWriter implementation that writes to a binary stream of data. This is the most commonly used implementation.

从以下版本开始:

3.0

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	BsonBinaryWriter.Context
protected class	BsonBinaryWriter.Mark

从类继承的嵌套类/接口 org.bson.AbstractBsonWriter

AbstractBsonWriter.State

构造器概要

构造器

构造器和说明
BsonBinaryWriter(BsonOutput bsonOutput) Construct an instance.
BsonBinaryWriter(BsonOutput bsonOutput, FieldNameValidator validator) Construct an instance.
BsonBinaryWriter(BsonWriterSettings settings, BsonBinaryWriterSettings binaryWriterSettings, BsonOutput bsonOutput) Construct an instance.
BsonBinaryWriter(BsonWriterSettings settings, BsonBinaryWriterSettings binaryWriterSettings, BsonOutput bsonOutput, FieldNameValidator validator) Construct an instance.

方法概要

限定符和类型	方法和说明
void	close()
protected void	doWriteBinaryData(BsonBinary value) Handles the logic of writing a BsonBinary value
void	doWriteBoolean(boolean value) Handles the logic of writing a boolean value
protected void	doWriteDateTime(long value) Handles the logic of writing a date time value
protected void	doWriteDBPointer(BsonDbPointer value) Handles the logic of writing a DbPointer value
protected void	doWriteDouble(double value) Handles the logic of writing a Double value
protected void	doWriteEndArray() Handles the logic of writing the end of an array
protected void	doWriteEndDocument() Handles the logic of writing the end of a document
protected void	doWriteInt32(int value) Handles the logic of writing an int32 value
protected void	doWriteInt64(long value) Handles the logic of writing an int64 value
protected void	doWriteJavaScript(java.lang.String value) Handles the logic of writing a JavaScript function
protected void	doWriteJavaScriptWithScope(java.lang.String value) Handles the logic of writing a scoped JavaScript function
protected void	doWriteMaxKey() Handles the logic of writing a Max key
protected void	doWriteMinKey() Handles the logic of writing a Min key
void	doWriteNull() Handles the logic of writing a Null value
void	doWriteObjectId(ObjectId value) Handles the logic of writing an ObjectId
void	doWriteRegularExpression(BsonRegularExpression value) Handles the logic of writing a regular expression
protected void	doWriteStartArray() Handles the logic to start writing an array
protected void	doWriteStartDocument() Handles the logic to start writing a document
void	doWriteString(java.lang.String value) Handles the logic of writing a String
void	doWriteSymbol(java.lang.String value) Handles the logic of writing a Symbol
void	doWriteTimestamp(BsonTimestamp value) Handles the logic of writing a timestamp
void	doWriteUndefined() Handles the logic of writing an Undefined value
void	flush() Flushes any pending data to the output destination.
BsonOutput	getBsonOutput() Gets the BSON output backing this instance.
protected BsonBinaryWriter.Context	getContext() Get the context, which will indicate which state the writer is in, for example which part of a document it's currently writing.
void	mark() Create a snapshot of this writer's context at a point in time.
void	pipe(BsonReader reader) Reads a single document from a BsonReader and writes it to this.
void	popMaxDocumentSize() Reset the maximum document size to its previous value.
void	pushMaxDocumentSize(int maxDocumentSize) Sets a maximum size for documents from this point.
void	reset() Resets this writer to the last mark() saved.

从类继承的方法 org.bson.AbstractBsonWriter

checkPreconditions, checkState, getName, getNextState, getState, isClosed, setContext, setState, throwInvalidContextType, throwInvalidState, writeBinaryData, writeBinaryData, writeBoolean, writeBoolean, writeDateTime, writeDateTime, writeDBPointer, writeDBPointer, writeDouble, writeDouble, writeEndArray, writeEndDocument, writeInt32, writeInt32, writeInt64, writeInt64, writeJavaScript, writeJavaScript, writeJavaScriptWithScope, writeJavaScriptWithScope, writeMaxKey, writeMaxKey, writeMinKey, writeMinKey, writeName, writeNull, writeNull, writeObjectId, writeObjectId, writeRegularExpression, writeRegularExpression, writeStartArray, writeStartArray, writeStartDocument, writeStartDocument, writeString, writeString, writeSymbol, writeSymbol, writeTimestamp, writeTimestamp, writeUndefined, writeUndefined

从类继承的方法 java.lang.Object

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

构造器详细资料

BsonBinaryWriter

public BsonBinaryWriter(BsonOutput bsonOutput,
                        FieldNameValidator validator)

Construct an instance.

参数:

bsonOutput - the output to write to

validator - the field name validator to apply

BsonBinaryWriter

public BsonBinaryWriter(BsonOutput bsonOutput)

Construct an instance.

参数:

bsonOutput - the output to write to

BsonBinaryWriter

public BsonBinaryWriter(BsonWriterSettings settings,
                        BsonBinaryWriterSettings binaryWriterSettings,
                        BsonOutput bsonOutput)

Construct an instance.

参数:

settings - the generic BsonWriter settings

binaryWriterSettings - the settings specific to a BsonBinaryWriter

bsonOutput - the output to write to

BsonBinaryWriter

public BsonBinaryWriter(BsonWriterSettings settings,
                        BsonBinaryWriterSettings binaryWriterSettings,
                        BsonOutput bsonOutput,
                        FieldNameValidator validator)

Construct an instance.

参数:

settings - the generic BsonWriter settings

binaryWriterSettings - the settings specific to a BsonBinaryWriter

bsonOutput - the output to write to

validator - the field name validator to apply

方法详细资料

close

public void close()

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

覆盖:

close 在类中 AbstractBsonWriter

getBsonOutput

public BsonOutput getBsonOutput()

Gets the BSON output backing this instance.

返回:

the BSON output

flush

public void flush()

从接口复制的说明: BsonWriter

Flushes any pending data to the output destination.

getContext

protected BsonBinaryWriter.Context getContext()

从类复制的说明: AbstractBsonWriter

Get the context, which will indicate which state the writer is in, for example which part of a document it's currently writing.

覆盖:

getContext 在类中 AbstractBsonWriter

返回:

the current context.

doWriteStartDocument

protected void doWriteStartDocument()

从类复制的说明: AbstractBsonWriter

Handles the logic to start writing a document

指定者:

doWriteStartDocument 在类中 AbstractBsonWriter

doWriteEndDocument

protected void doWriteEndDocument()

从类复制的说明: AbstractBsonWriter

Handles the logic of writing the end of a document

指定者:

doWriteEndDocument 在类中 AbstractBsonWriter

doWriteStartArray

protected void doWriteStartArray()

从类复制的说明: AbstractBsonWriter

Handles the logic to start writing an array

指定者:

doWriteStartArray 在类中 AbstractBsonWriter

doWriteEndArray

protected void doWriteEndArray()

从类复制的说明: AbstractBsonWriter

Handles the logic of writing the end of an array

指定者:

doWriteEndArray 在类中 AbstractBsonWriter

doWriteBinaryData

protected void doWriteBinaryData(BsonBinary value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a BsonBinary value

指定者:

doWriteBinaryData 在类中 AbstractBsonWriter

参数:

value - the BsonBinary value to write

doWriteBoolean

public void doWriteBoolean(boolean value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a boolean value

指定者:

doWriteBoolean 在类中 AbstractBsonWriter

参数:

value - the boolean value to write

doWriteDateTime

protected void doWriteDateTime(long value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a date time value

指定者:

doWriteDateTime 在类中 AbstractBsonWriter

参数:

value - the long value to write

doWriteDBPointer

protected void doWriteDBPointer(BsonDbPointer value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a DbPointer value

指定者:

doWriteDBPointer 在类中 AbstractBsonWriter

参数:

value - the BsonDbPointer value to write

doWriteDouble

protected void doWriteDouble(double value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a Double value

指定者:

doWriteDouble 在类中 AbstractBsonWriter

参数:

value - the double value to write

doWriteInt32

protected void doWriteInt32(int value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing an int32 value

指定者:

doWriteInt32 在类中 AbstractBsonWriter

参数:

value - the int value to write

doWriteInt64

protected void doWriteInt64(long value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing an int64 value

指定者:

doWriteInt64 在类中 AbstractBsonWriter

参数:

value - the long value to write

doWriteJavaScript

protected void doWriteJavaScript(java.lang.String value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a JavaScript function

指定者:

doWriteJavaScript 在类中 AbstractBsonWriter

参数:

value - the String value to write

doWriteJavaScriptWithScope

protected void doWriteJavaScriptWithScope(java.lang.String value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a scoped JavaScript function

指定者:

doWriteJavaScriptWithScope 在类中 AbstractBsonWriter

参数:

value - the boolean value to write

doWriteMaxKey

protected void doWriteMaxKey()

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a Max key

指定者:

doWriteMaxKey 在类中 AbstractBsonWriter

doWriteMinKey

protected void doWriteMinKey()

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a Min key

指定者:

doWriteMinKey 在类中 AbstractBsonWriter

doWriteNull

public void doWriteNull()

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a Null value

指定者:

doWriteNull 在类中 AbstractBsonWriter

doWriteObjectId

public void doWriteObjectId(ObjectId value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing an ObjectId

指定者:

doWriteObjectId 在类中 AbstractBsonWriter

参数:

value - the ObjectId value to write

doWriteRegularExpression

public void doWriteRegularExpression(BsonRegularExpression value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a regular expression

指定者:

doWriteRegularExpression 在类中 AbstractBsonWriter

参数:

value - the BsonRegularExpression value to write

doWriteString

public void doWriteString(java.lang.String value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a String

指定者:

doWriteString 在类中 AbstractBsonWriter

参数:

value - the String value to write

doWriteSymbol

public void doWriteSymbol(java.lang.String value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a Symbol

指定者:

doWriteSymbol 在类中 AbstractBsonWriter

参数:

value - the boolean value to write

doWriteTimestamp

public void doWriteTimestamp(BsonTimestamp value)

从类复制的说明: AbstractBsonWriter

Handles the logic of writing a timestamp

指定者:

doWriteTimestamp 在类中 AbstractBsonWriter

参数:

value - the BsonTimestamp value to write

doWriteUndefined

public void doWriteUndefined()

从类复制的说明: AbstractBsonWriter

Handles the logic of writing an Undefined value

指定者:

doWriteUndefined 在类中 AbstractBsonWriter

pipe

public void pipe(BsonReader reader)

从接口复制的说明: BsonWriter

Reads a single document from a BsonReader and writes it to this.

指定者:

pipe 在接口中 BsonWriter

覆盖:

pipe 在类中 AbstractBsonWriter

参数:

reader - The source.

pushMaxDocumentSize

public void pushMaxDocumentSize(int maxDocumentSize)

Sets a maximum size for documents from this point.

参数:

maxDocumentSize - the maximum document size.

popMaxDocumentSize

public void popMaxDocumentSize()

Reset the maximum document size to its previous value.

mark

public void mark()

Create a snapshot of this writer's context at a point in time.

reset

public void reset()

Resets this writer to the last mark() saved.

抛出:

java.lang.IllegalStateException - if mark() was not called prior to reset.