BsonGenerator (cookjson 1.0 API)

java.lang.Object
- org.yuanheng.cookjson.BsonGenerator

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, JsonGenerator, CookJsonGenerator
```
public class BsonGenerator
extends Object
implements CookJsonGenerator
```
A simple implementation of JsonGenerator that generates output in BSON format.
Because BSON does not support BigDecimal and BigInteger types, they are stored as string literals. It is possible to store them as double (for certain range of values). To do so, use the function setUseDouble(boolean).
It should be noted that the generated BSON file is in a stream format that has 0's for Document / Array type lengths. While BsonParser has no problems reading the file, some utilities such as bsondump do require them to be correctly specified. Use BsonFixLength.fix(java.io.File) to update the length information.

Author:

Heng Yuan

Field Summary
- Fields inherited from interface javax.json.stream.JsonGenerator
  PRETTY_PRINTING

Constructor Summary

Constructors
Constructor and Description

BsonGenerator(OutputStream os)
Constructor for BsonGenerator.

Constructors
Constructor and Description
`BsonGenerator(OutputStream os)` Constructor for BsonGenerator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`flush()`
`void`	`setUseDouble(boolean b)` If the flag is set to true, `BigDecimal` / `BigInteger` values are stored as double instead of string.
`JsonGenerator`	`write(BigDecimal value)`
`JsonGenerator`	`write(BigInteger value)`
`JsonGenerator`	`write(boolean value)`
`JsonGenerator`	`write(byte[] value)` Writes the specified data as a binary value within the current array context.
`JsonGenerator`	`write(double value)`
`JsonGenerator`	`write(int value)`
`JsonGenerator`	`write(JsonValue value)`
`JsonGenerator`	`write(long value)`
`JsonGenerator`	`write(String value)`
`JsonGenerator`	`write(String name, BigDecimal value)`
`JsonGenerator`	`write(String name, BigInteger value)`
`JsonGenerator`	`write(String name, boolean value)`
`JsonGenerator`	`write(String name, byte[] value)` Writes the specified data as a binary value within the current object context.
`JsonGenerator`	`write(String name, double value)`
`JsonGenerator`	`write(String name, int value)`
`JsonGenerator`	`write(String name, JsonValue value)`
`JsonGenerator`	`write(String name, long value)`
`JsonGenerator`	`write(String name, String value)`
`JsonGenerator`	`writeEnd()`
`JsonGenerator`	`writeNull()`
`JsonGenerator`	`writeNull(String name)`
`JsonGenerator`	`writeStartArray()`
`JsonGenerator`	`writeStartArray(String name)`
`JsonGenerator`	`writeStartObject()`
`JsonGenerator`	`writeStartObject(String name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BsonGenerator
```
public BsonGenerator(OutputStream os)
```
    Constructor for BsonGenerator.
    
    Parameters:
    
    os - the output stream.
- Method Detail
  - setUseDouble
```
public void setUseDouble(boolean b)
```
    If the flag is set to true, BigDecimal / BigInteger values are stored as double instead of string.
    
    Parameters:
    
    b - boolean flag.
  - writeStartObject
```
public JsonGenerator writeStartObject()
```
    Specified by:
    
    writeStartObject in interface JsonGenerator
  - writeStartObject
```
public JsonGenerator writeStartObject(String name)
```
    Specified by:
    
    writeStartObject in interface JsonGenerator
  - writeStartArray
```
public JsonGenerator writeStartArray()
```
    Specified by:
    
    writeStartArray in interface JsonGenerator
  - writeStartArray
```
public JsonGenerator writeStartArray(String name)
```
    Specified by:
    
    writeStartArray in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           JsonValue value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           byte[] value)
```
    Description copied from interface: CookJsonGenerator
    
    Writes the specified data as a binary value within the current object context. Depends on the implementation, it can be written as binary, or as Base64 / Hexadecimal strings.
    
    Specified by:
    
    write in interface CookJsonGenerator
    
    Parameters:
    
    name - the key name.
    
    value - a binary data to be written
    
    Returns:
    
    this.
    
    See Also:
    
    CookJsonBinary
  - write
```
public JsonGenerator write(String name,
                           String value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           BigInteger value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           BigDecimal value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           int value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           long value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           double value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(String name,
                           boolean value)
```
    Specified by:
    
    write in interface JsonGenerator
  - writeNull
```
public JsonGenerator writeNull(String name)
```
    Specified by:
    
    writeNull in interface JsonGenerator
  - writeEnd
```
public JsonGenerator writeEnd()
```
    Specified by:
    
    writeEnd in interface JsonGenerator
  - write
```
public JsonGenerator write(JsonValue value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(byte[] value)
```
    Description copied from interface: CookJsonGenerator
    
    Writes the specified data as a binary value within the current array context. Depends on the implementation, it can be written as binary, or as Base64 / Hexadecimal strings.
    
    Specified by:
    
    write in interface CookJsonGenerator
    
    Parameters:
    
    value - a binary data to be written
    
    Returns:
    
    this.
    
    See Also:
    
    CookJsonBinary
  - write
```
public JsonGenerator write(String value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(BigDecimal value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(BigInteger value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(int value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(long value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(double value)
```
    Specified by:
    
    write in interface JsonGenerator
  - write
```
public JsonGenerator write(boolean value)
```
    Specified by:
    
    write in interface JsonGenerator
  - writeNull
```
public JsonGenerator writeNull()
```
    Specified by:
    
    writeNull in interface JsonGenerator
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface JsonGenerator
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface Flushable
    
    Specified by:
    
    flush in interface JsonGenerator

Class BsonGenerator

Field Summary

Fields inherited from interface javax.json.stream.JsonGenerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BsonGenerator

Method Detail

setUseDouble

writeStartObject

writeStartObject

writeStartArray

writeStartArray

write

write

write

write

write

write

write

write

write

writeNull

writeEnd

write

write

write

write

write

write

write

write

write

writeNull

close

flush