org.opendaylight.yangtools.yang.data.codec.gson

Class JSONNormalizedNodeStreamWriter

java.lang.Object

org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

public class JSONNormalizedNodeStreamWriter
extends Object
implements org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

This implementation will create JSON output as output stream. Values of leaf and leaf-list are NOT translated according to codecs.

Field Summary

Fields inherited from interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

UNKNOWN_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
void	anyxmlNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, Object value)
void	close()
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	create(JSONCodecFactory codecFactory, Writer writer, int indentSize) Create a new stream writer, which writes to the specified output stream.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, org.opendaylight.yangtools.yang.model.api.SchemaPath path, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, org.opendaylight.yangtools.yang.model.api.SchemaPath path, URI initialNs, Writer writer) Create a new stream writer, which writes to the specified Writer.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, org.opendaylight.yangtools.yang.model.api.SchemaPath path, Writer writer) Create a new stream writer, which writes to the specified Writer.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, Writer writer) Create a new stream writer, which writes to the specified Writer.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, Writer writer, int indentSize) Create a new stream writer, which writes to the specified output stream.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	createExclusiveWriter(JSONCodecFactory codecFactory, org.opendaylight.yangtools.yang.model.api.SchemaPath path, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	createNestedWriter(JSONCodecFactory codecFactory, org.opendaylight.yangtools.yang.model.api.SchemaPath path, URI initialNs, com.google.gson.stream.JsonWriter jsonWriter) Create a new stream writer, which writes to the specified output stream.
void	endNode()
void	flush()
void	leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, Object value)
void	leafSetEntryNode(Object value)
void	startAugmentationNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier identifier)
void	startChoiceNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)
void	startContainerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)
void	startLeafSet(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)
void	startMapEntryNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates identifier, int childSizeHint)
void	startMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)
void	startOrderedMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)
void	startUnkeyedList(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)
void	startUnkeyedListItem(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, int childSizeHint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                       Writer writer)

Create a new stream writer, which writes to the specified Writer. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

schemaContext - Schema context

writer - Output writer

Returns:

A stream writer instance

create

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                       org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                       Writer writer)

Create a new stream writer, which writes to the specified Writer. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

schemaContext - Schema context

path - Root schemapath

writer - Output writer

Returns:

A stream writer instance

create

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                       org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                       URI initialNs,
                                                                                       Writer writer)

Create a new stream writer, which writes to the specified Writer. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

schemaContext - Schema context

path - Root schemapath

writer - Output writer

initialNs - Initial namespace

Returns:

A stream writer instance

create

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                       Writer writer,
                                                                                       int indentSize)

Create a new stream writer, which writes to the specified output stream. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

schemaContext - Schema context

writer - Output writer

indentSize - indentation size

Returns:

A stream writer instance

create

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter create(JSONCodecFactory codecFactory,
                                                                                       Writer writer,
                                                                                       int indentSize)

Create a new stream writer, which writes to the specified output stream. The codec factory can be reused between multiple writers. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

codecFactory - JSON codec factory

writer - Output writer

indentSize - indentation size

Returns:

A stream writer instance

create

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter create(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                       org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                       URI initialNs,
                                                                                       com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

schemaContext - Schema context

path - Schema Path

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

createExclusiveWriter

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter createExclusiveWriter(JSONCodecFactory codecFactory,
                                                                                                      org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                                      URI initialNs,
                                                                                                      com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream. The codec factory can be reused between multiple writers. Returned writer is exclusive user of JsonWriter, which means it will start top-level JSON element and ends it. This instance of writer can be used only to emit one top level element, therwise it will produce incorrect JSON.

Parameters:

codecFactory - JSON codec factory

path - Schema Path

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

createNestedWriter

public static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter createNestedWriter(JSONCodecFactory codecFactory,
                                                                                                   org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                                                                   URI initialNs,
                                                                                                   com.google.gson.stream.JsonWriter jsonWriter)

Create a new stream writer, which writes to the specified output stream. The codec factory can be reused between multiple writers. Returned writer can be used emit multiple top level element, but does not start / close parent JSON object, which must be done by user providing jsonWriter instance in order for JSON to be valid.

Parameters:

codecFactory - JSON codec factory

path - Schema Path

initialNs - Initial namespace

jsonWriter - JsonWriter

Returns:

A stream writer instance

leafNode

public void leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
            Object value)
              throws IOException

Specified by:

leafNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startLeafSet

public void startLeafSet(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                int childSizeHint)
                  throws IOException

Specified by:

startLeafSet in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

leafSetEntryNode

public void leafSetEntryNode(Object value)
                      throws IOException

Specified by:

leafSetEntryNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startContainerNode

public void startContainerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                      int childSizeHint)
                        throws IOException

Specified by:

startContainerNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startUnkeyedList

public void startUnkeyedList(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                    int childSizeHint)
                      throws IOException

Specified by:

startUnkeyedList in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startUnkeyedListItem

public void startUnkeyedListItem(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                        int childSizeHint)
                          throws IOException

Specified by:

startUnkeyedListItem in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startMapNode

public void startMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                int childSizeHint)
                  throws IOException

Specified by:

startMapNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startMapEntryNode

public void startMapEntryNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates identifier,
                     int childSizeHint)
                       throws IOException

Specified by:

startMapEntryNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startOrderedMapNode

public void startOrderedMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                       int childSizeHint)
                         throws IOException

Specified by:

startOrderedMapNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

startChoiceNode

public void startChoiceNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                   int childSizeHint)

Specified by:

startChoiceNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

startAugmentationNode

public void startAugmentationNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier identifier)

Specified by:

startAugmentationNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

anyxmlNode

public void anyxmlNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
              Object value)
                throws IOException

Specified by:

anyxmlNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

endNode

public void endNode()
             throws IOException

Specified by:

endNode in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter

Throws:

IOException