BSON (SequoiaDB Java Driver 3.0 API)

java.lang.Object
- org.bson.BSON

```
public class BSON
extends Object
```
Global setting for BSON usage.

字段概要

字段
限定符和类型	字段和说明
`protected static Charset`	`_utf8`
`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_DECIMAL`
`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(Class c, Transformer t)` Add a decoding hook for transforming a instance of BSON supported classes into a instance of class c.
`static void`	`addEncodingHook(Class c, Transformer t)` Add a encoding hook for transforming a instance of class c into a instance of the BSON supported classes.
`static Object`	`applyDecodingHooks(Object o)` Use the registered decoding hooks to transform the instance of BSON supported classes into another instance of user expect.
`static Object`	`applyEncodingHooks(Object o)` Use the registered encoding hooks to transform the specific instance into the instance of BSON supported classes.
`static void`	`clearAllHooks()` Remove all the hooks.
`static void`	`clearDecodingHooks()` Clears all decoding hooks.
`static void`	`clearEncodingHooks()` Clears all encoding hooks.
`static BSONObject`	`decode(byte[] b)` Decode the bytes into a BSONObject instance.
`static BSONObject`	`decode(byte[] b, int offset)` Decode the bytes into a BSONObject instance.
`static byte[]`	`encode(BSONObject o)` Encoding a BSONObject instance into bytes
`static List<Transformer>`	`getDecodingHooks(Class c)` Returns the decoding hook(s) associated with the specific class
`static List<Transformer>`	`getEncodingHooks(Class c)` Returns the encoding hook(s) associated with the specified class
`static boolean`	`getJSCompatibility()` Get whether the display mode of BSON is the same with that in sdb shell or not.
`static boolean`	`hasDecodeHooks()` check has decode hooks or not.
`static boolean`	`IsBasicType(Object obj)`
`static int`	`regexFlag(char c)`
`static String`	`regexFlags(int flags)` Converts Java regular expression flags into a string of flags for the database
`static int`	`regexFlags(String flags)` Converts a string of regular expression flags from the database in Java regular expression flags.
`static void`	`removeDecodingHook(Class c, Transformer t)` Remove a specific encoding hook for a specific class.
`static void`	`removeDecodingHooks(Class c)` Remove all decoding hooks for a specific class.
`static void`	`removeEncodingHook(Class c, Transformer t)` Remove a specific encoding hook for a specific class.
`static void`	`removeEncodingHooks(Class c)` Remove all encoding hooks for a specific class.
`static void`	`setJSCompatibility(boolean compatible)` When "compatible" is true, the content of BasicBSONObject method "toString" is show absolutely the same with which is show in sdb shell.
`static int`	`toInt(Object o)`

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

字段详细资料
- _utf8
```
protected static Charset _utf8
```
- ARRAY
```
public static final byte ARRAY
```
  另请参阅:
  
  常量字段值
- B_BINARY
```
public static final byte B_BINARY
```
  另请参阅:
  
  常量字段值
- B_FUNC
```
public static final byte B_FUNC
```
  另请参阅:
  
  常量字段值
- B_GENERAL
```
public static final byte B_GENERAL
```
  另请参阅:
  
  常量字段值
- B_UUID
```
public static final byte B_UUID
```
  另请参阅:
  
  常量字段值
- BINARY
```
public static final byte BINARY
```
  另请参阅:
  
  常量字段值
- BOOLEAN
```
public static final byte BOOLEAN
```
  另请参阅:
  
  常量字段值
- CODE
```
public static final byte CODE
```
  另请参阅:
  
  常量字段值
- CODE_W_SCOPE
```
public static final byte CODE_W_SCOPE
```
  另请参阅:
  
  常量字段值
- DATE
```
public static final byte DATE
```
  另请参阅:
  
  常量字段值
- EOO
```
public static final byte EOO
```
  另请参阅:
  
  常量字段值
- MAXKEY
```
public static final byte MAXKEY
```
  另请参阅:
  
  常量字段值
- MINKEY
```
public static final byte MINKEY
```
  另请参阅:
  
  常量字段值
- NULL
```
public static final byte NULL
```
  另请参阅:
  
  常量字段值
- NUMBER
```
public static final byte NUMBER
```
  另请参阅:
  
  常量字段值
- NUMBER_DECIMAL
```
public static final byte NUMBER_DECIMAL
```
  另请参阅:
  
  常量字段值
- NUMBER_INT
```
public static final byte NUMBER_INT
```
  另请参阅:
  
  常量字段值
- NUMBER_LONG
```
public static final byte NUMBER_LONG
```
  另请参阅:
  
  常量字段值
- OBJECT
```
public static final byte OBJECT
```
  另请参阅:
  
  常量字段值
- OID
```
public static final byte OID
```
  另请参阅:
  
  常量字段值
- REF
```
public static final byte REF
```
  另请参阅:
  
  常量字段值
- REGEX
```
public static final byte REGEX
```
  另请参阅:
  
  常量字段值
- STRING
```
public static final byte STRING
```
  另请参阅:
  
  常量字段值
- SYMBOL
```
public static final byte SYMBOL
```
  另请参阅:
  
  常量字段值
- TIMESTAMP
```
public static final byte TIMESTAMP
```
  另请参阅:
  
  常量字段值
- UNDEFINED
```
public static final byte UNDEFINED
```
  另请参阅:
  
  常量字段值

构造器详细资料
- BSON
```
public BSON()
```

方法详细资料

addDecodingHook

public static void addDecodingHook(Class c,
                                   Transformer t)

Add a decoding hook for transforming a instance of BSON supported classes into a instance of class c.

  Usage:
  public void testEncodeDecodeHook() {
       BSON.addEncodingHook(GregorianCalendar.class, new Transformer() {
          public Object transform(Object o) {
               return ((GregorianCalendar)o).getTime();
           }
       });

       BSON.addDecodingHook(Date.class, new Transformer() {
           public Object transform(Object o) {
               Calendar calendar = new GregorianCalendar();
               calendar.setTime((Date)o);
               return calendar;
           }
       });

       Calendar calendar = new GregorianCalendar();
       calendar.set(2015, 0,1);
       BSONObject object = new BasicBSONObject();
       object.put("calendar", calendar);
       cl.insert(object);
       DBCursor cursor = cl.query();
       while(cursor.hasNext()) {
           BSONObject record = cursor.getNext();
           System.out.println("record is: " + record);
           Object resultObject = record.get("calendar");
           calendar.equals(resultObject);
           Assert.assertTrue(resultObject instanceof GregorianCalendar);
       }
   }

参数:: c - the class of the instance which is going to be transformed into.; t - the Transformer, user should defines the transform rule.

addEncodingHook

public static void addEncodingHook(Class c,
                                   Transformer t)

Add a encoding hook for transforming a instance of class c into a instance of the BSON supported classes.

  Usage:
  public void testEncodeDecodeHook() {
       BSON.addEncodingHook(GregorianCalendar.class, new Transformer() {
          public Object transform(Object o) {
               return ((GregorianCalendar)o).getTime();
           }
       });

       BSON.addDecodingHook(Date.class, new Transformer() {
           public Object transform(Object o) {
               Calendar calendar = new GregorianCalendar();
               calendar.setTime((Date)o);
               return calendar;
           }
       });

       Calendar calendar = new GregorianCalendar();
       calendar.set(2015, 0,1);
       BSONObject object = new BasicBSONObject();
       object.put("calendar", calendar);
       cl.insert(object);
       DBCursor cursor = cl.query();
       while(cursor.hasNext()) {
           BSONObject record = cursor.getNext();
           System.out.println("record is: " + record);
           Object resultObject = record.get("calendar");
           calendar.equals(resultObject);
           Assert.assertTrue(resultObject instanceof GregorianCalendar);
       }
   }

参数:: c - the class of the instance which is going to be transformed.; t - the Transformer, user should defines the transform rule.

applyDecodingHooks
```
public static Object applyDecodingHooks(Object o)
```
Use the registered decoding hooks to transform the instance of BSON supported classes into another instance of user expect.

参数:

o -

返回:

applyEncodingHooks
```
public static Object applyEncodingHooks(Object o)
```
Use the registered encoding hooks to transform the specific instance into the instance of BSON supported classes.

参数:

o -

返回:

clearAllHooks
```
public static void clearAllHooks()
```
Remove all the hooks.

clearDecodingHooks
```
public static void clearDecodingHooks()
```
Clears all decoding hooks.

clearEncodingHooks
```
public static void clearEncodingHooks()
```
Clears all encoding hooks.

decode
```
public static BSONObject decode(byte[] b)
```
Decode the bytes into a BSONObject instance.

参数:

b - bytes to be decoded.

返回:

a BSONObject instance.

decode
```
public static BSONObject decode(byte[] b,
                                int offset)
```
Decode the bytes into a BSONObject instance.

参数:

b - bytes to be decoded.

offset - the start position.

返回:

a BSONObject instance.

encode
```
public static byte[] encode(BSONObject o)
```
Encoding a BSONObject instance into bytes

参数:

o - the instance of BSONObject.

返回:

the bytes.

getDecodingHooks
```
public static List<Transformer> getDecodingHooks(Class c)
```
Returns the decoding hook(s) associated with the specific class

getEncodingHooks
```
public static List<Transformer> getEncodingHooks(Class c)
```
Returns the encoding hook(s) associated with the specified class

参数:

c - the specified class for getting it's registered encoding hook.

返回:

all the registered encoding hooks.

getJSCompatibility
```
public static boolean getJSCompatibility()
```
Get whether the display mode of BSON is the same with that in sdb shell or not.

返回:

true or false.

另请参阅:

setJSCompatibility(boolean)

hasDecodeHooks
```
public static boolean hasDecodeHooks()
```
check has decode hooks or not.

返回:

true for having, and false for not

IsBasicType

public static boolean IsBasicType(Object obj)

regexFlag
```
public static int regexFlag(char c)
```

regexFlags
```
public static String regexFlags(int flags)
```
Converts Java regular expression flags into a string of flags for the database

参数:

flags - Java flags

返回:

the flags for the database

regexFlags
```
public static int regexFlags(String flags)
```
Converts a string of regular expression flags from the database in Java regular expression flags.

参数:

flags - flags from database

返回:

the Java flags

removeDecodingHook

public static void removeDecodingHook(Class c,
                                      Transformer t)

Remove a specific encoding hook for a specific class.

removeDecodingHooks
```
public static void removeDecodingHooks(Class c)
```
Remove all decoding hooks for a specific class.

removeEncodingHook

public static void removeEncodingHook(Class c,
                                      Transformer t)

Remove a specific encoding hook for a specific class.

removeEncodingHooks
```
public static void removeEncodingHooks(Class c)
```
Remove all encoding hooks for a specific class.

setJSCompatibility
```
public static void setJSCompatibility(boolean compatible)
```
When "compatible" is true, the content of BasicBSONObject method "toString" is show absolutely the same with which is show in sdb shell.

参数:

compatible - true or false, default to be false; // we have a bson as below: BSONObject obj = new BasicBSONObject("a", Long.MAX_VALUE); // sdb shell shows this bson like this: {"a" : { "$numberLong" : "9223372036854775807"}} // sdb shell use javascript grammer, so, it can't display number // which is great that 2^53 - 1. So it use "$numberLong" to represent // the type, and keep the number between the quotes. // However, in java, when we use "obj.toString()", // most of the time, we don't hope to get a result with // the format "$numberLong", we hope to see the result as // below: {"a" : 9223372036854775807} // When parameter "compatible" is false, we get this kind of result // all the time. Otherwise, we get a result which is show as the sdb shell shows.

toInt
```
public static int toInt(Object o)
```

类 BSON

字段概要

构造器概要

方法概要

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

字段详细资料

_utf8

ARRAY

B_BINARY

B_FUNC

B_GENERAL

B_UUID

BINARY

BOOLEAN

CODE

CODE_W_SCOPE

DATE

EOO

MAXKEY

MINKEY

NULL

NUMBER

NUMBER_DECIMAL

NUMBER_INT

NUMBER_LONG

OBJECT

OID

REF

REGEX

STRING

SYMBOL

TIMESTAMP

UNDEFINED

构造器详细资料

BSON

方法详细资料

addDecodingHook

addEncodingHook

applyDecodingHooks

applyEncodingHooks

clearAllHooks

clearDecodingHooks

clearEncodingHooks

decode

decode

encode

getDecodingHooks

getEncodingHooks

getJSCompatibility

hasDecodeHooks

IsBasicType

regexFlag

regexFlags

regexFlags

removeDecodingHook

removeDecodingHooks

removeEncodingHook

removeEncodingHooks

setJSCompatibility

toInt