JsonWriter (Genson 1.6 API)

java.lang.Object
- com.owlike.genson.stream.JsonWriter

All Implemented Interfaces:: ObjectWriter

public class JsonWriter
extends Object
implements ObjectWriter

Constructor Summary

Constructors
Constructor and Description

JsonWriter(Writer writer)

JsonWriter(Writer writer, boolean skipNull, boolean htmlSafe, boolean indentation)

Constructors
Constructor and Description
`JsonWriter(Writer writer)`
`JsonWriter(Writer writer, boolean skipNull, boolean htmlSafe, boolean indentation)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected JsonWriter`	`begin(JsonType jsonType, char token)`
`JsonWriter`	`beginArray()` Starts to write an array (use it also for collections).
`ObjectWriter`	`beginNextObjectMetadata()` This method is a kind of cheat as it allows us to start writing metadata and then still be able to call beginObject.
`JsonWriter`	`beginObject()` Starts a object, objects are a suite of name/value pairs, values may be literals, arrays or objects.
`void`	`close()`
`JsonType`	`enclosingType()`
`JsonWriter`	`endArray()` Ends the array, if beginArray was not called, implementations should throw an exception.
`JsonWriter`	`endObject()` Ends the object being written, if beginObject was not called an exception will be throwed.
`static char[]`	`escapeString(String value)`
`void`	`flush()`
`protected void`	`indent()`
`Writer`	`unwrap()`
`ObjectWriter`	`writeBoolean(Boolean value)`
`ObjectWriter`	`writeBoolean(String name, Boolean value)`
`ObjectWriter`	`writeBytes(byte[] value)`
`ObjectWriter`	`writeBytes(String name, byte[] value)`
`ObjectWriter`	`writeEscapedName(char[] name)` Will write the name without escaping special characters, assuming it has been done by the caller or the string doesn't contain any character needing to be escaped.
`protected int`	`writeInt(long value)`
`ObjectWriter`	`writeMetadata(String name, String value)` Metadata is a suite of name/value pairs, names will be prepended with '@' (handled by the library).
`JsonWriter`	`writeName(String name)` Writes the name of a property.
`ObjectWriter`	`writeNull()` Must be called when a null value is encountered.
`ObjectWriter`	`writeNumber(Number value)`
`ObjectWriter`	`writeNumber(String name, Number value)`
`ObjectWriter`	`writeString(String value)` Similar to writeValue(String) but is null safe, meaning that if the value is null, then the write will call writeNull for you.
`ObjectWriter`	`writeString(String name, String value)` Will write the name and the value, it is just a shortcut for writer.writeName("key").writeString(value).
`JsonWriter`	`writeUnsafeValue(String value)` Writes value as is without any pre-processing, it's faster than `ObjectWriter.writeValue(String)` but should be used only if you know that it is safe.
`JsonWriter`	`writeValue(boolean value)` See `ObjectWriter.writeValue(int)`.
`ObjectWriter`	`writeValue(byte[] value)` Writes an array of bytes as a base64 encoded string.
`JsonWriter`	`writeValue(double value)` See `ObjectWriter.writeValue(int)`.
`ObjectWriter`	`writeValue(float value)`
`JsonWriter`	`writeValue(int value)` Writes a value to the stream.
`JsonWriter`	`writeValue(long value)` See `ObjectWriter.writeValue(int)`.
`JsonWriter`	`writeValue(Number value)` See `ObjectWriter.writeValue(int)`.
`ObjectWriter`	`writeValue(short value)` See `ObjectWriter.writeValue(int)`.
`JsonWriter`	`writeValue(String value)` See `ObjectWriter.writeValue(int)`.

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

- Constructor Detail
  - JsonWriter
```
public JsonWriter(Writer writer)
```
  - JsonWriter
```
public JsonWriter(Writer writer,
                  boolean skipNull,
                  boolean htmlSafe,
                  boolean indentation)
```
- Method Detail
  - enclosingType
```
public JsonType enclosingType()
```
    Specified by:
    
    enclosingType in interface ObjectWriter
  - close
```
public void close()
```
    Specified by:
    
    close in interface ObjectWriter
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface ObjectWriter
  - beginArray
```
public JsonWriter beginArray()
```
    Description copied from interface: ObjectWriter
    
    Starts to write an array (use it also for collections). An array is a suite of values that may be literals, arrays or objects. When you finished writing the values don't forget to call endArray().
    
    Specified by:
    
    beginArray in interface ObjectWriter
    
    Returns:
    
    a reference to this allowing to chain method calls.
  - beginObject
```
public JsonWriter beginObject()
```
    Description copied from interface: ObjectWriter
    
    Starts a object, objects are a suite of name/value pairs, values may be literals, arrays or objects. Don't forget to call endObject.
    
    Specified by:
    
    beginObject in interface ObjectWriter
    
    Returns:
    
    a reference to this allowing to chain method calls.
  - begin
```
protected final JsonWriter begin(JsonType jsonType,
                                 char token)
```
  - endArray
```
public JsonWriter endArray()
```
    Description copied from interface: ObjectWriter
    
    Ends the array, if beginArray was not called, implementations should throw an exception.
    
    Specified by:
    
    endArray in interface ObjectWriter
    
    Returns:
    
    a reference to this allowing to chain method calls.
  - endObject
```
public JsonWriter endObject()
```
    Description copied from interface: ObjectWriter
    
    Ends the object being written, if beginObject was not called an exception will be throwed.
    
    Specified by:
    
    endObject in interface ObjectWriter
    
    Returns:
    
    a reference to this allowing to chain method calls.
  - indent
```
protected void indent()
```
  - writeName
```
public JsonWriter writeName(String name)
```
    Description copied from interface: ObjectWriter
    
    Writes the name of a property. Names can be written only in objects and must be called before writing the properties value.
    
    Specified by:
    
    writeName in interface ObjectWriter
    
    Parameters:
    
    name - a non null String
    
    Returns:
    
    a reference to this, allowing to chain method calls.
  - writeEscapedName
```
public ObjectWriter writeEscapedName(char[] name)
```
    Description copied from interface: ObjectWriter
    
    Will write the name without escaping special characters, assuming it has been done by the caller or the string doesn't contain any character needing to be escaped.
    
    Specified by:
    
    writeEscapedName in interface ObjectWriter
    
    Parameters:
    
    name - a non null escaped String
    
    Returns:
    
    a reference to this, allowing to chain method calls.
  - writeValue
```
public JsonWriter writeValue(int value)
```
    Description copied from interface: ObjectWriter
    
    Writes a value to the stream. Values can be written in arrays and in objects (after writing the name).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    Parameters:
    
    value - to write.
    
    Returns:
    
    a reference to this, allowing to chain method calls.
  - writeValue
```
public JsonWriter writeValue(double value)
```
    Description copied from interface: ObjectWriter
    
    See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeValue
```
public JsonWriter writeValue(long value)
```
    Description copied from interface: ObjectWriter
    
    See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeValue
```
public ObjectWriter writeValue(short value)
```
    Description copied from interface: ObjectWriter
    
    See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeValue
```
public ObjectWriter writeValue(float value)
```
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeValue
```
public JsonWriter writeValue(boolean value)
```
    Description copied from interface: ObjectWriter
    
    See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeInt
```
protected final int writeInt(long value)
```
  - writeValue
```
public JsonWriter writeValue(Number value)
```
    Description copied from interface: ObjectWriter
    
    See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeBoolean
```
public ObjectWriter writeBoolean(Boolean value)
```
    Specified by:
    
    writeBoolean in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeString(String)
  - writeNumber
```
public ObjectWriter writeNumber(Number value)
```
    Specified by:
    
    writeNumber in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeString(String)
  - writeString
```
public ObjectWriter writeString(String value)
```
    Description copied from interface: ObjectWriter
    
    Similar to writeValue(String) but is null safe, meaning that if the value is null, then the write will call writeNull for you.
    
    Specified by:
    
    writeString in interface ObjectWriter
  - writeBytes
```
public ObjectWriter writeBytes(byte[] value)
```
    Specified by:
    
    writeBytes in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeString(String)
  - writeValue
```
public ObjectWriter writeValue(byte[] value)
```
    Description copied from interface: ObjectWriter
    
    Writes an array of bytes as a base64 encoded string. See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeUnsafeValue
```
public JsonWriter writeUnsafeValue(String value)
```
    Description copied from interface: ObjectWriter
    
    Writes value as is without any pre-processing, it's faster than ObjectWriter.writeValue(String) but should be used only if you know that it is safe.
    
    Specified by:
    
    writeUnsafeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - writeValue
```
public JsonWriter writeValue(String value)
```
    Description copied from interface: ObjectWriter
    
    See ObjectWriter.writeValue(int).
    
    Specified by:
    
    writeValue in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - escapeString
```
public static final char[] escapeString(String value)
```
  - writeNull
```
public ObjectWriter writeNull()
```
    Description copied from interface: ObjectWriter
    
    Must be called when a null value is encountered. Implementations will deal with the null representation (just skip it or write null, etc).
    
    Specified by:
    
    writeNull in interface ObjectWriter
    
    Returns:
    
    a reference to this allowing to chain method calls.
    
    See Also:
    
    ObjectWriter.writeValue(int)
  - beginNextObjectMetadata
```
public ObjectWriter beginNextObjectMetadata()
```
    Description copied from interface: ObjectWriter
    
    This method is a kind of cheat as it allows us to start writing metadata and then still be able to call beginObject. This is mainly intended to be used in wrapped converters that want to handle a part of the serialization and then let the chain continue. Have a look at ClassMetadataConverter
    
    Specified by:
    
    beginNextObjectMetadata in interface ObjectWriter
    
    Returns:
    
    a reference to this allowing to chain method calls.
    
    See Also:
    
    ObjectWriter.writeMetadata(String, String)
  - writeMetadata
```
public ObjectWriter writeMetadata(String name,
                                  String value)
```
    Description copied from interface: ObjectWriter
    Metadata is a suite of name/value pairs, names will be prepended with '@' (handled by the library). Metadata feature is experimental for the moment so things may change a bit. The signature will not, but the way it is implemented could... Actually the contract is that metadata must be written first and only in objects. If it does not respect these conditions ObjectReader won't be able to detect it as metadata. Here is an example of two ways to write object metadata.
```
 // here it is transparent for the library if you write metadata or something else, you must call
 // beginObject before being able to start writing its metadata.
 writer.beginObject().writeMetadata("doc", "Object documentation bla bla...").writeName("name")
                .writeNull().endObject().flush();

 // previous example works fine, but if you want to write some metadata and still be able to call
 // beginObject (for example in a converter you want to write some metadata and have all the existing
 // continue to work with calling beginObject) you must use beginNextObjectMetadata.

 // written from a first converter
 writer.beginNextObjectMetadata().writeMetadata("dataFromConverter1", "writtenFromConverter1");
 // written from a second converter after first one
 writer.beginNextObjectMetadata().writeMetadata("dataFromConverter2", "writtenFromConverter2");
 // finally concrete properties will be written from a custom converter
 writer.beginObject().writeName("name").writeNull().endObject().flush();
 
```
    Specified by:
    
    writeMetadata in interface ObjectWriter
    
    Parameters:
    
    name - of the metadata property, should not start with '@', the library will add it.
    
    value - of the metadata property.
    
    Returns:
    
    a reference to this allowing to chain method calls.
    
    See Also:
    
    ObjectWriter.beginNextObjectMetadata()
  - writeBoolean
```
public ObjectWriter writeBoolean(String name,
                                 Boolean value)
```
    Specified by:
    
    writeBoolean in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeString(String, String)
  - writeNumber
```
public ObjectWriter writeNumber(String name,
                                Number value)
```
    Specified by:
    
    writeNumber in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeString(String, String)
  - writeString
```
public ObjectWriter writeString(String name,
                                String value)
```
    Description copied from interface: ObjectWriter
    
    Will write the name and the value, it is just a shortcut for writer.writeName("key").writeString(value). Note if the value is null, writeNull is used.
    
    Specified by:
    
    writeString in interface ObjectWriter
  - writeBytes
```
public ObjectWriter writeBytes(String name,
                               byte[] value)
```
    Specified by:
    
    writeBytes in interface ObjectWriter
    
    See Also:
    
    ObjectWriter.writeString(String, String)
  - unwrap
```
public Writer unwrap()
```

Class JsonWriter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JsonWriter

JsonWriter

Method Detail

enclosingType

close

flush

beginArray

beginObject

begin

endArray

endObject

indent

writeName

writeEscapedName

writeValue

writeValue

writeValue

writeValue

writeValue

writeValue

writeInt

writeValue

writeBoolean

writeNumber

writeString

writeBytes

writeValue

writeUnsafeValue

writeValue

escapeString

writeNull

beginNextObjectMetadata

writeMetadata

writeBoolean

writeNumber

writeString

writeBytes

unwrap