JsonAppendableWriter (venice 1.5.11 API)

java.lang.Object
- com.github.jlangch.venice.nanojson.JsonAppendableWriter

All Implemented Interfaces:: JsonSink<JsonAppendableWriter>

public final class JsonAppendableWriter
extends java.lang.Object
implements JsonSink<JsonAppendableWriter>

JSON writer that emits JSON to a Appendable. Create this class with JsonWriter.on(Appendable) or JsonWriter.on(OutputStream).

 OutputStream out = ...;
 JsonWriter
     .indent("  ")
     .on(out)
     .object()
         .array("a")
             .value(1)
             .value(2)
         .end()
         .value("b", false)
         .value("c", true)
     .end()
 .done();

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Appendable appendable

protected java.io.OutputStream out

protected boolean utf8

Fields
Modifier and Type	Field and Description
`protected java.lang.Appendable`	`appendable`
`protected java.io.OutputStream`	`out`
`protected boolean`	`utf8`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SELF`	`array()` Starts an array.
`SELF`	`array(java.util.Collection<?> c)` Emits the start of an array.
`SELF`	`array(java.lang.String key)` Starts an array within an object, prefixed with a key.
`SELF`	`array(java.lang.String key, java.util.Collection<?> c)` Emits the start of an array with a key.
`void`	`done()` Closes this JSON writer and flushes the underlying `Appendable` if it is also `Flushable`.
`protected void`	`doneInternal()` Ensures that the object is in the finished state.
`SELF`	`end()` Ends the current array or object.
`SELF`	`nul()` Emits a 'null' token.
`SELF`	`nul(java.lang.String key)` Emits a 'null' token with a key.
`SELF`	`object()` Starts an object.
`SELF`	`object(java.util.Map<?,?> map)` Emits the start of an object.
`SELF`	`object(java.lang.String key)` Starts an object within an object, prefixed with a key.
`SELF`	`object(java.lang.String key, java.util.Map<?,?> map)` Emits the start of an object with a key.
`SELF`	`value(boolean b)` Emits a boolean value.
`SELF`	`value(double d)` Emits a double value.
`SELF`	`value(float d)` Emits a float value.
`SELF`	`value(int i)` Emits an integer value.
`SELF`	`value(long l)` Emits a long value.
`SELF`	`value(java.lang.Number n)` Emits a `Number` value.
`SELF`	`value(java.lang.Object o)` Emits an object if it is a JSON-compatible type, otherwise throws an exception.
`SELF`	`value(java.lang.String s)` Emits a string value (or null).
`SELF`	`value(java.lang.String key, boolean b)` Emits a boolean value with a key.
`SELF`	`value(java.lang.String key, double d)` Emits a double value with a key.
`SELF`	`value(java.lang.String key, float d)` Emits a float value with a key.
`SELF`	`value(java.lang.String key, int i)` Emits an integer value with a key.
`SELF`	`value(java.lang.String key, long l)` Emits a long value with a key.
`SELF`	`value(java.lang.String key, java.lang.Number n)` Emits a `Number` value with a key.
`SELF`	`value(java.lang.String key, java.lang.Object o)` Emits an object with a key if it is a JSON-compatible type, otherwise throws an exception.
`SELF`	`value(java.lang.String key, java.lang.String s)` Emits a string value (or null) with a key.

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

Methods inherited from interface com.github.jlangch.venice.nanojson.JsonSink
array, array, array, array, end, nul, nul, object, object, object, object, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value

- Field Detail
  - appendable
```
protected final java.lang.Appendable appendable
```
  - out
```
protected final java.io.OutputStream out
```
  - utf8
```
protected final boolean utf8
```
- Method Detail
  - done
```
public void done()
          throws JsonWriterException
```
    Closes this JSON writer and flushes the underlying Appendable if it is also Flushable.
    
    Throws:
    
    JsonWriterException - if the underlying Flushable Appendable failed to flush.
  - array
```
public SELF array(java.util.Collection<?> c)
```
    Description copied from interface: JsonSink
    
    Emits the start of an array.
    
    Specified by:
    
    array in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - array
```
public SELF array(java.lang.String key,
                  java.util.Collection<?> c)
```
    Description copied from interface: JsonSink
    
    Emits the start of an array with a key.
    
    Specified by:
    
    array in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - object
```
public SELF object(java.util.Map<?,?> map)
```
    Description copied from interface: JsonSink
    
    Emits the start of an object.
    
    Specified by:
    
    object in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - object
```
public SELF object(java.lang.String key,
                   java.util.Map<?,?> map)
```
    Description copied from interface: JsonSink
    
    Emits the start of an object with a key.
    
    Specified by:
    
    object in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - nul
```
public SELF nul()
```
    Description copied from interface: JsonSink
    
    Emits a 'null' token.
    
    Specified by:
    
    nul in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - nul
```
public SELF nul(java.lang.String key)
```
    Description copied from interface: JsonSink
    
    Emits a 'null' token with a key.
    
    Specified by:
    
    nul in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.Object o)
```
    Description copied from interface: JsonSink
    
    Emits an object if it is a JSON-compatible type, otherwise throws an exception.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  java.lang.Object o)
```
    Description copied from interface: JsonSink
    
    Emits an object with a key if it is a JSON-compatible type, otherwise throws an exception.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String s)
```
    Description copied from interface: JsonSink
    
    Emits a string value (or null).
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(int i)
```
    Description copied from interface: JsonSink
    
    Emits an integer value.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(long l)
```
    Description copied from interface: JsonSink
    
    Emits a long value.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(boolean b)
```
    Description copied from interface: JsonSink
    
    Emits a boolean value.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(double d)
```
    Description copied from interface: JsonSink
    
    Emits a double value.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(float d)
```
    Description copied from interface: JsonSink
    
    Emits a float value.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.Number n)
```
    Description copied from interface: JsonSink
    
    Emits a Number value.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  java.lang.String s)
```
    Description copied from interface: JsonSink
    
    Emits a string value (or null) with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  int i)
```
    Description copied from interface: JsonSink
    
    Emits an integer value with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  long l)
```
    Description copied from interface: JsonSink
    
    Emits a long value with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  boolean b)
```
    Description copied from interface: JsonSink
    
    Emits a boolean value with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  double d)
```
    Description copied from interface: JsonSink
    
    Emits a double value with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  float d)
```
    Description copied from interface: JsonSink
    
    Emits a float value with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - value
```
public SELF value(java.lang.String key,
                  java.lang.Number n)
```
    Description copied from interface: JsonSink
    
    Emits a Number value with a key.
    
    Specified by:
    
    value in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - array
```
public SELF array()
```
    Description copied from interface: JsonSink
    
    Starts an array.
    
    Specified by:
    
    array in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - object
```
public SELF object()
```
    Description copied from interface: JsonSink
    
    Starts an object.
    
    Specified by:
    
    object in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - array
```
public SELF array(java.lang.String key)
```
    Description copied from interface: JsonSink
    
    Starts an array within an object, prefixed with a key.
    
    Specified by:
    
    array in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - object
```
public SELF object(java.lang.String key)
```
    Description copied from interface: JsonSink
    
    Starts an object within an object, prefixed with a key.
    
    Specified by:
    
    object in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - end
```
public SELF end()
```
    Description copied from interface: JsonSink
    
    Ends the current array or object.
    
    Specified by:
    
    end in interface JsonSink<SELF extends com.github.jlangch.venice.nanojson.JsonWriterBase<SELF>>
  - doneInternal
```
protected void doneInternal()
```
    Ensures that the object is in the finished state.
    
    Throws:
    
    JsonWriterException - if the written JSON is not properly balanced, ie: all arrays and objects that were started have been properly ended.

Class JsonAppendableWriter

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.github.jlangch.venice.nanojson.JsonSink

Field Detail

appendable

out

utf8

Method Detail

done

array

array

object

object

nul

nul

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

value

array

object

array

object

end

doneInternal