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

java.lang.Object
- org.bson.BSON

直接已知子类:

Bytes
```
public class BSON
extends java.lang.Object
```
Contains byte representations of all the BSON types (see the BSON Specification). Also supports the registration of encoding and decoding hooks to transform BSON types during encoding or decoding.

另请参阅:

Transformer

字段概要

字段
限定符和类型	字段和说明
`static byte`	`ARRAY`
`static byte`	`B_BINARY`
`static byte`	`B_FUNC`
`static byte`	`B_GENERAL`
`static byte`	`B_UUID`
`static byte`	`BINARY`
`static byte`	`BOOLEAN`
`static byte`	`CODE`
`static byte`	`CODE_W_SCOPE`
`static byte`	`DATE`
`static byte`	`EOO`
`static byte`	`MAXKEY`
`static byte`	`MINKEY`
`static byte`	`NULL`
`static byte`	`NUMBER`
`static byte`	`NUMBER_INT`
`static byte`	`NUMBER_LONG`
`static byte`	`OBJECT`
`static byte`	`OID`
`static byte`	`REF`
`static byte`	`REGEX`
`static byte`	`STRING`
`static byte`	`SYMBOL`
`static byte`	`TIMESTAMP`
`static byte`	`UNDEFINED`

构造器概要

构造器
构造器和说明

BSON()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`addDecodingHook(java.lang.Class<?> clazz, Transformer transformer)` Registers a `Transformer` to use when decoding a specific class from BSON.
`static void`	`addEncodingHook(java.lang.Class<?> clazz, Transformer transformer)` Registers a `Transformer` to use to encode a specific class into BSON.
`static java.lang.Object`	`applyDecodingHooks(java.lang.Object objectToDecode)` Transforms the `objectToDecode` using all transformers registered for the class of this object.
`static java.lang.Object`	`applyEncodingHooks(java.lang.Object objectToEncode)` Transforms the `objectToEncode` using all transformers registered for the class of this object.
`static void`	`clearAllHooks()` Remove all decoding and encoding hooks for all classes.
`static void`	`clearDecodingHooks()` Clears all decoding hooks.
`static void`	`clearEncodingHooks()` Clears all encoding hooks.
`static BSONObject`	`decode(byte[] bytes)` Decodes a BSON byte array into a DBObject instance.
`static byte[]`	`encode(BSONObject doc)` Encodes a DBObject as a BSON byte array.
`static java.util.List<Transformer>`	`getDecodingHooks(java.lang.Class<?> clazz)` Returns the decoding hook(s) associated with the specific class
`static java.util.List<Transformer>`	`getEncodingHooks(java.lang.Class<?> clazz)` Returns the encoding hook(s) associated with the specified class.
`static boolean`	`hasDecodeHooks()` Gets whether any decoding transformers have been registered for any classes.
`static boolean`	`hasEncodeHooks()` Gets whether any encoding transformers have been registered for any classes.
`static int`	`regexFlag(char c)` Converts a regular expression modifier from the database into Java regular expression flags.
`static java.lang.String`	`regexFlags(int flags)` Converts Java regular expression flags into regular expression modifiers from the database.
`static int`	`regexFlags(java.lang.String s)` Converts a sequence of regular expression modifiers from the database into Java regular expression flags.
`static void`	`removeDecodingHook(java.lang.Class<?> clazz, Transformer transformer)` Remove a specific encoding hook for a specific class.
`static void`	`removeDecodingHooks(java.lang.Class<?> clazz)` Remove all decoding hooks for a specific class.
`static void`	`removeEncodingHook(java.lang.Class<?> clazz, Transformer transformer)` Remove a specific encoding hook for a specific class.
`static void`	`removeEncodingHooks(java.lang.Class<?> clazz)` Remove all encoding hooks for a specific class.
`static int`	`toInt(java.lang.Object number)` Provides an integer representation of Boolean or Number.

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

- 字段详细资料
  - EOO
```
public static final byte EOO
```
    另请参阅:
    
    常量字段值
  - NUMBER
```
public static final byte NUMBER
```
    另请参阅:
    
    常量字段值
  - STRING
```
public static final byte STRING
```
    另请参阅:
    
    常量字段值
  - OBJECT
```
public static final byte OBJECT
```
    另请参阅:
    
    常量字段值
  - ARRAY
```
public static final byte ARRAY
```
    另请参阅:
    
    常量字段值
  - BINARY
```
public static final byte BINARY
```
    另请参阅:
    
    常量字段值
  - UNDEFINED
```
public static final byte UNDEFINED
```
    另请参阅:
    
    常量字段值
  - OID
```
public static final byte OID
```
    另请参阅:
    
    常量字段值
  - BOOLEAN
```
public static final byte BOOLEAN
```
    另请参阅:
    
    常量字段值
  - DATE
```
public static final byte DATE
```
    另请参阅:
    
    常量字段值
  - NULL
```
public static final byte NULL
```
    另请参阅:
    
    常量字段值
  - REGEX
```
public static final byte REGEX
```
    另请参阅:
    
    常量字段值
  - REF
```
public static final byte REF
```
    另请参阅:
    
    常量字段值
  - CODE
```
public static final byte CODE
```
    另请参阅:
    
    常量字段值
  - SYMBOL
```
public static final byte SYMBOL
```
    另请参阅:
    
    常量字段值
  - CODE_W_SCOPE
```
public static final byte CODE_W_SCOPE
```
    另请参阅:
    
    常量字段值
  - NUMBER_INT
```
public static final byte NUMBER_INT
```
    另请参阅:
    
    常量字段值
  - TIMESTAMP
```
public static final byte TIMESTAMP
```
    另请参阅:
    
    常量字段值
  - NUMBER_LONG
```
public static final byte NUMBER_LONG
```
    另请参阅:
    
    常量字段值
  - MINKEY
```
public static final byte MINKEY
```
    另请参阅:
    
    常量字段值
  - MAXKEY
```
public static final byte MAXKEY
```
    另请参阅:
    
    常量字段值
  - B_GENERAL
```
public static final byte B_GENERAL
```
    另请参阅:
    
    常量字段值
  - B_FUNC
```
public static final byte B_FUNC
```
    另请参阅:
    
    常量字段值
  - B_BINARY
```
public static final byte B_BINARY
```
    另请参阅:
    
    常量字段值
  - B_UUID
```
public static final byte B_UUID
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - BSON
```
public BSON()
```
- 方法详细资料
  - hasEncodeHooks
```
public static boolean hasEncodeHooks()
```
    Gets whether any encoding transformers have been registered for any classes.
    
    返回:
    
    true if any encoding hooks have been registered.
  - hasDecodeHooks
```
public static boolean hasDecodeHooks()
```
    Gets whether any decoding transformers have been registered for any classes.
    
    返回:
    
    true if any decoding hooks have been registered.
  - addEncodingHook
```
public static void addEncodingHook(java.lang.Class<?> clazz,
                                   Transformer transformer)
```
    Registers a Transformer to use to encode a specific class into BSON.
    
    参数:
    
    clazz - the class to be transformed during encoding
    
    transformer - the transformer to use during encoding
  - addDecodingHook
```
public static void addDecodingHook(java.lang.Class<?> clazz,
                                   Transformer transformer)
```
    Registers a Transformer to use when decoding a specific class from BSON. This class will be one of the basic types supported by BSON.
    
    参数:
    
    clazz - the class to be transformed during decoding
    
    transformer - the transformer to use during decoding
  - applyEncodingHooks
```
public static java.lang.Object applyEncodingHooks(java.lang.Object objectToEncode)
```
    Transforms the objectToEncode using all transformers registered for the class of this object.
    
    参数:
    
    objectToEncode - the object being written to BSON.
    
    返回:
    
    the transformed object
  - applyDecodingHooks
```
public static java.lang.Object applyDecodingHooks(java.lang.Object objectToDecode)
```
    Transforms the objectToDecode using all transformers registered for the class of this object.
    
    参数:
    
    objectToDecode - the BSON object to decode
    
    返回:
    
    the transformed object
  - getEncodingHooks
```
public static java.util.List<Transformer> getEncodingHooks(java.lang.Class<?> clazz)
```
    Returns the encoding hook(s) associated with the specified class.
    
    参数:
    
    clazz - the class to fetch the encoding hooks for
    
    返回:
    
    a List of encoding transformers that apply to the given class
  - clearEncodingHooks
```
public static void clearEncodingHooks()
```
    Clears all encoding hooks.
  - removeEncodingHooks
```
public static void removeEncodingHooks(java.lang.Class<?> clazz)
```
    Remove all encoding hooks for a specific class.
    
    参数:
    
    clazz - the class to remove all the decoding hooks for
  - removeEncodingHook
```
public static void removeEncodingHook(java.lang.Class<?> clazz,
                                      Transformer transformer)
```
    Remove a specific encoding hook for a specific class. The transformer passed as the parameter must be equals to the transformer to remove.
    
    参数:
    
    clazz - the class to remove the encoding hook for
    
    transformer - the specific encoding hook to remove.
  - getDecodingHooks
```
public static java.util.List<Transformer> getDecodingHooks(java.lang.Class<?> clazz)
```
    Returns the decoding hook(s) associated with the specific class
    
    参数:
    
    clazz - the class to fetch the decoding hooks for
    
    返回:
    
    a List of all the decoding Transformers that apply to the given class
  - clearDecodingHooks
```
public static void clearDecodingHooks()
```
    Clears all decoding hooks.
  - removeDecodingHooks
```
public static void removeDecodingHooks(java.lang.Class<?> clazz)
```
    Remove all decoding hooks for a specific class.
    
    参数:
    
    clazz - the class to remove all the decoding hooks for
  - removeDecodingHook
```
public static void removeDecodingHook(java.lang.Class<?> clazz,
                                      Transformer transformer)
```
    Remove a specific encoding hook for a specific class. The transformer passed as the parameter must be equals to the transformer to remove.
    
    参数:
    
    clazz - the class to remove the decoding hook for
    
    transformer - the specific decoding hook to remove.
  - clearAllHooks
```
public static void clearAllHooks()
```
    Remove all decoding and encoding hooks for all classes.
  - encode
```
public static byte[] encode(BSONObject doc)
```
    Encodes a DBObject as a BSON byte array.
    
    参数:
    
    doc - the document to encode
    
    返回:
    
    the document encoded as BSON
  - decode
```
public static BSONObject decode(byte[] bytes)
```
    Decodes a BSON byte array into a DBObject instance.
    
    参数:
    
    bytes - a document encoded as BSON
    
    返回:
    
    the document as a DBObject
  - regexFlags
```
public static int regexFlags(java.lang.String s)
```
    Converts a sequence of regular expression modifiers from the database into Java regular expression flags.
    
    参数:
    
    s - regular expression modifiers
    
    返回:
    
    the Java flags
    
    抛出:
    
    java.lang.IllegalArgumentException - If sequence contains invalid flags.
  - regexFlag
```
public static int regexFlag(char c)
```
    Converts a regular expression modifier from the database into Java regular expression flags.
    
    参数:
    
    c - regular expression modifier
    
    返回:
    
    the Java flags
    
    抛出:
    
    java.lang.IllegalArgumentException - If sequence contains invalid flags.
  - regexFlags
```
public static java.lang.String regexFlags(int flags)
```
    Converts Java regular expression flags into regular expression modifiers from the database.
    
    参数:
    
    flags - the Java flags
    
    返回:
    
    the Java flags
    
    抛出:
    
    java.lang.IllegalArgumentException - if some flags couldn't be recognized.
  - toInt
```
public static int toInt(java.lang.Object number)
```
    Provides an integer representation of Boolean or Number. If argument is Boolean, then 1 for true will be returned or @{code 0} otherwise. If argument is Number, then Number.intValue() will be called.
    
    参数:
    
    number - the number to convert to an int
    
    返回:
    
    integer value
    
    抛出:
    
    java.lang.IllegalArgumentException - if the argument is null or not Boolean or Number

类 BSON

字段概要

构造器概要

方法概要

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

字段详细资料

EOO

NUMBER

STRING

OBJECT

ARRAY

BINARY

UNDEFINED

OID

BOOLEAN

DATE

NULL

REGEX

REF

CODE

SYMBOL

CODE_W_SCOPE

NUMBER_INT

TIMESTAMP

NUMBER_LONG

MINKEY

MAXKEY

B_GENERAL

B_FUNC

B_BINARY

B_UUID

构造器详细资料

BSON

方法详细资料

hasEncodeHooks

hasDecodeHooks

addEncodingHook

addDecodingHook

applyEncodingHooks

applyDecodingHooks

getEncodingHooks

clearEncodingHooks

removeEncodingHooks

removeEncodingHook

getDecodingHooks

clearDecodingHooks

removeDecodingHooks

removeDecodingHook

clearAllHooks

encode

decode

regexFlags

regexFlag

regexFlags

toInt