BasicBSONEncoder (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- org.bson.BasicBSONEncoder

所有已实现的接口:

BSONEncoder

直接已知子类:

DefaultDBEncoder
```
public class BasicBSONEncoder
extends java.lang.Object
implements BSONEncoder
```
This is meant to be pooled or cached. There is some per instance memory for string conversion, etc...

构造器概要

构造器
构造器和说明

BasicBSONEncoder()

构造器
构造器和说明
`BasicBSONEncoder()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`_putObjectField(java.lang.String name, java.lang.Object initialValue)` Encodes any Object type
`void`	`done()` Free the resources.
`byte[]`	`encode(BSONObject document)` Encode a document into byte array.
`protected BsonBinaryWriter`	`getBsonWriter()` Gets the writer responsible for writing the encoded BSON.
`protected OutputBuffer`	`getOutputBuffer()` Gets the buffer the BSON is being encoded into.
`protected void`	`putArray(java.lang.String name, java.lang.Object object)` Encodes an array field.
`protected void`	`putBinary(java.lang.String name, Binary binary)` Encodes a Binary field
`protected void`	`putBinary(java.lang.String name, byte[] bytes)` Encodes a byte array field
`protected void`	`putBoolean(java.lang.String name, java.lang.Boolean value)` Encodes a field with a `Boolean` or `boolean` value
`protected void`	`putCode(java.lang.String name, Code code)` Encodes a field to a `BsonType.JAVASCRIPT` value.
`protected void`	`putCodeWScope(java.lang.String name, CodeWScope codeWScope)` Encodes a field to a `BsonType.JAVASCRIPT_WITH_SCOPE` value.
`protected void`	`putDate(java.lang.String name, java.util.Date date)` Encodes a field with data and time value.
`protected void`	`putIterable(java.lang.String name, java.lang.Iterable iterable)` Encodes an Iterable, for example `List` values
`protected void`	`putMap(java.lang.String name, java.util.Map map)` Encodes a map, as a BSON document
`protected void`	`putMaxKey(java.lang.String name)` Encodes a field to a `BsonType.MAX_KEY` value.
`protected void`	`putMinKey(java.lang.String name)` Encodes a field to a `BsonType.MIN_KEY` value.
`protected void`	`putName(java.lang.String name)` Writes a field name
`protected void`	`putNull(java.lang.String name)` Encodes a null value
`protected void`	`putNumber(java.lang.String name, java.lang.Number number)` Encodes any number field.
`int`	`putObject(BSONObject document)` Encodes a `BSONObject`.
`protected int`	`putObject(java.lang.String name, BSONObject document)` Encodes any `BSONObject`, as a document
`protected void`	`putObjectId(java.lang.String name, ObjectId objectId)` Encodes an ObjectId field to a `BsonType.OBJECT_ID`.
`protected void`	`putPattern(java.lang.String name, java.util.regex.Pattern value)` Encodes a Pattern field to a `BsonType.REGULAR_EXPRESSION`.
`protected boolean`	`putSpecial(java.lang.String name, java.lang.Object special)` Special values are not encoded into documents.
`protected void`	`putString(java.lang.String name, java.lang.String value)` Encodes a String field
`protected void`	`putSymbol(java.lang.String name, Symbol symbol)` Encodes a Symbol field
`protected void`	`putTimestamp(java.lang.String name, BSONTimestamp timestamp)` Encodes a BSON timestamp
`protected void`	`putUndefined(java.lang.String name)` Encodes an undefined value
`protected void`	`putUUID(java.lang.String name, java.util.UUID uuid)` Encodes a field with a `UUID` value.
`void`	`set(OutputBuffer buffer)` Sets the buffer to wrich the result of encoding will be written.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - BasicBSONEncoder
```
public BasicBSONEncoder()
```
- 方法详细资料
  - encode
```
public byte[] encode(BSONObject document)
```
    从接口复制的说明: BSONEncoder
    Encode a document into byte array. This is a shortcut method which creates a new OutputBuffer, invokes the other 3 methods in a corresponding sequence:
    and returns the contents of the OutputBuffer.
    指定者:
    
    encode 在接口中 BSONEncoder
    
    参数:
    
    document - the document to be encoded
    
    返回:
    
    a byte sequence
  - done
```
public void done()
```
    从接口复制的说明: BSONEncoder
    
    Free the resources.
    
    指定者:
    
    done 在接口中 BSONEncoder
  - set
```
public void set(OutputBuffer buffer)
```
    从接口复制的说明: BSONEncoder
    
    Sets the buffer to wrich the result of encoding will be written.
    
    指定者:
    
    set 在接口中 BSONEncoder
    
    参数:
    
    buffer - the buffer to be used to write a byte sequences to
  - getOutputBuffer
```
protected OutputBuffer getOutputBuffer()
```
    Gets the buffer the BSON is being encoded into.
    
    返回:
    
    the OutputBuffer
  - getBsonWriter
```
protected BsonBinaryWriter getBsonWriter()
```
    Gets the writer responsible for writing the encoded BSON.
    
    返回:
    
    the writer used to write the encoded BSON
  - putObject
```
public int putObject(BSONObject document)
```
    Encodes a BSONObject. This is for the higher level api calls.
    
    指定者:
    
    putObject 在接口中 BSONEncoder
    
    参数:
    
    document - the document to encode
    
    返回:
    
    the number of characters in the encoding
  - putName
```
protected void putName(java.lang.String name)
```
    Writes a field name
    
    参数:
    
    name - the field name
  - _putObjectField
```
protected void _putObjectField(java.lang.String name,
                               java.lang.Object initialValue)
```
    Encodes any Object type
    
    参数:
    
    name - the field name
    
    initialValue - the value to write
  - putNull
```
protected void putNull(java.lang.String name)
```
    Encodes a null value
    
    参数:
    
    name - the field name
    
    另请参阅:
    
    BsonType.NULL
  - putUndefined
```
protected void putUndefined(java.lang.String name)
```
    Encodes an undefined value
    
    参数:
    
    name - the field name
    
    另请参阅:
    
    BsonType.UNDEFINED
  - putTimestamp
```
protected void putTimestamp(java.lang.String name,
                            BSONTimestamp timestamp)
```
    Encodes a BSON timestamp
    
    参数:
    
    name - the field name
    
    timestamp - the timestamp to encode
    
    另请参阅:
    
    BsonType.TIMESTAMP
  - putCode
```
protected void putCode(java.lang.String name,
                       Code code)
```
    Encodes a field to a BsonType.JAVASCRIPT value.
    
    参数:
    
    name - the field name
    
    code - the value
  - putCodeWScope
```
protected void putCodeWScope(java.lang.String name,
                             CodeWScope codeWScope)
```
    Encodes a field to a BsonType.JAVASCRIPT_WITH_SCOPE value.
    
    参数:
    
    name - the field name
    
    codeWScope - the value
  - putBoolean
```
protected void putBoolean(java.lang.String name,
                          java.lang.Boolean value)
```
    Encodes a field with a Boolean or boolean value
    
    参数:
    
    name - the field name
    
    value - the value
  - putDate
```
protected void putDate(java.lang.String name,
                       java.util.Date date)
```
    Encodes a field with data and time value.
    
    参数:
    
    name - the field name
    
    date - the value
    
    另请参阅:
    
    BsonType.DATE_TIME
  - putNumber
```
protected void putNumber(java.lang.String name,
                         java.lang.Number number)
```
    Encodes any number field.
    
    参数:
    
    name - the field name
    
    number - the value
  - putBinary
```
protected void putBinary(java.lang.String name,
                         byte[] bytes)
```
    Encodes a byte array field
    
    参数:
    
    name - the field name
    
    bytes - the value
    
    另请参阅:
    
    BsonType.BINARY
  - putBinary
```
protected void putBinary(java.lang.String name,
                         Binary binary)
```
    Encodes a Binary field
    
    参数:
    
    name - the field name
    
    binary - the value
    
    另请参阅:
    
    BsonType.BINARY
  - putUUID
```
protected void putUUID(java.lang.String name,
                       java.util.UUID uuid)
```
    Encodes a field with a UUID value. This is encoded to a binary value of subtype BsonBinarySubType.UUID_LEGACY
    
    参数:
    
    name - the field name
    
    uuid - the value
  - putSymbol
```
protected void putSymbol(java.lang.String name,
                         Symbol symbol)
```
    Encodes a Symbol field
    
    参数:
    
    name - the field name
    
    symbol - the value
    
    另请参阅:
    
    BsonType.SYMBOL
  - putString
```
protected void putString(java.lang.String name,
                         java.lang.String value)
```
    Encodes a String field
    
    参数:
    
    name - the field name
    
    value - the value
    
    另请参阅:
    
    BsonType.STRING
  - putPattern
```
protected void putPattern(java.lang.String name,
                          java.util.regex.Pattern value)
```
    Encodes a Pattern field to a BsonType.REGULAR_EXPRESSION.
    
    参数:
    
    name - the field name
    
    value - the value
    
    另请参阅:
    
    BsonType.BINARY
    
    MongoDB documentation
    
    $regex
  - putObjectId
```
protected void putObjectId(java.lang.String name,
                           ObjectId objectId)
```
    Encodes an ObjectId field to a BsonType.OBJECT_ID.
    
    参数:
    
    name - the field name
    
    objectId - the value
  - putArray
```
protected void putArray(java.lang.String name,
                        java.lang.Object object)
```
    Encodes an array field.
    
    参数:
    
    name - the field name
    
    object - the array, which can be any sort of primitive or String array
  - putIterable
```
protected void putIterable(java.lang.String name,
                           java.lang.Iterable iterable)
```
    Encodes an Iterable, for example List values
    
    参数:
    
    name - the field name
    
    iterable - the value
  - putMap
```
protected void putMap(java.lang.String name,
                      java.util.Map map)
```
    Encodes a map, as a BSON document
    
    参数:
    
    name - the field name
    
    map - the value
  - putObject
```
protected int putObject(java.lang.String name,
                        BSONObject document)
```
    Encodes any BSONObject, as a document
    
    参数:
    
    name - the field name
    
    document - the value
    
    返回:
    
    the number of characters in the encoding
  - putSpecial
```
protected boolean putSpecial(java.lang.String name,
                             java.lang.Object special)
```
    Special values are not encoded into documents.
    
    参数:
    
    name - the field name
    
    special - the value
    
    返回:
    
    true if the operation is successful. This implementation always returns false.
  - putMinKey
```
protected void putMinKey(java.lang.String name)
```
    Encodes a field to a BsonType.MIN_KEY value.
    
    参数:
    
    name - the field name
  - putMaxKey
```
protected void putMaxKey(java.lang.String name)
```
    Encodes a field to a BsonType.MAX_KEY value.
    
    参数:
    
    name - the field name

类 BasicBSONEncoder

构造器概要

方法概要

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

构造器详细资料

BasicBSONEncoder

方法详细资料

encode

done

set

getOutputBuffer

getBsonWriter

putObject

putName

_putObjectField

putNull

putUndefined

putTimestamp

putCode

putCodeWScope

putBoolean

putDate

putNumber

putBinary

putBinary

putUUID

putSymbol

putString

putPattern

putObjectId

putArray

putIterable

putMap

putObject

putSpecial

putMinKey

putMaxKey