X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-data-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fdata%2Fapi%2Fschema%2Fstream%2FNormalizedNodeStreamWriter.java;h=13d314282a6d35f2b34e7cbb5b2b2c868774f0d8;hb=c13c841a2311ac4c0c507451624e0b3ddf26e775;hp=96b5c15e91e933f0075c0eb9f1e6f446c332b4f9;hpb=b8ac1a71bb9b2f950f8b55c8357aac777a63a83c;p=yangtools.git diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java index 96b5c15e91..13d314282a 100644 --- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java +++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java @@ -7,6 +7,10 @@ */ package org.opendaylight.yangtools.yang.data.api.schema.stream; +import java.io.Closeable; +import java.io.Flushable; +import java.io.IOException; + import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; @@ -34,13 +38,13 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdent * and finished using {@link #endNode()}. * *
UnkeyedList
- Unkeyed list represent list without keys,
- * unkeyed list start is emmited using {@link #startUnkeyedList(NodeIdentifier, int)} list
- * end is emmited using {@link #endNode()}. Each list item is emmited using
+ * unkeyed list start is emitted using {@link #startUnkeyedList(NodeIdentifier, int)} list
+ * end is emitted using {@link #endNode()}. Each list item is emitted using
* {@link #startUnkeyedListItem(NodeIdentifier, int)} and ended using {@link #endNode()}.leaf
- Leaf node event is emitted using
- * {@link #leafNode(NodeIdentifier, Object)}. {@link #endNode()} MUST NOT BE emmited for
+ * {@link #leafNode(NodeIdentifier, Object)}. {@link #endNode()} MUST NOT BE emitted for
* leaf node.leaf-list
- Leaf list start is emitted using
@@ -49,7 +53,7 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdent
* {@link #leafSetEntryNode(Object).
*
* anyxml - Anyxml node event is emitted using
- * {@link #leafNode(NodeIdentifier, Object)}. {@link #endNode()} MUST NOT BE emmited
+ * {@link #leafNode(NodeIdentifier, Object)}. {@link #endNode()} MUST NOT BE emitted
* for anyxml node.
map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void leafNode(NodeIdentifier name, Object value) throws IllegalArgumentException;
+ void leafNode(NodeIdentifier name, Object value) throws IOException, IllegalArgumentException;
/**
*
@@ -130,8 +135,9 @@ public interface NormalizedNodeStreamWriter {
* @throws IllegalStateException
* If node was emitted inside map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startLeafSet(NodeIdentifier name, int childSizeHint) throws IllegalArgumentException;
+ void startLeafSet(NodeIdentifier name, int childSizeHint) throws IOException, IllegalArgumentException;
/**
* Emits a leaf set entry node
@@ -142,8 +148,9 @@ public interface NormalizedNodeStreamWriter {
* If emitted leaf node has invalid value.
* @throws IllegalStateException
* If node was emitted outside leaf set
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void leafSetEntryNode(Object value) throws IllegalArgumentException;
+ void leafSetEntryNode(Object value) throws IOException, IllegalArgumentException;
/**
*
@@ -161,8 +168,8 @@ public interface NormalizedNodeStreamWriter {
* map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startContainerNode(NodeIdentifier name, int childSizeHint) throws IllegalArgumentException;
+ void startContainerNode(NodeIdentifier name, int childSizeHint) throws IOException, IllegalArgumentException;
/**
*
@@ -204,8 +212,9 @@ public interface NormalizedNodeStreamWriter {
* @throws IllegalStateException
* If node was emitted inside map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startUnkeyedList(NodeIdentifier name, int childSizeHint) throws IllegalArgumentException;
+ void startUnkeyedList(NodeIdentifier name, int childSizeHint) throws IOException, IllegalArgumentException;
/**
* Emits start of new unkeyed list item.
@@ -231,8 +240,9 @@ public interface NormalizedNodeStreamWriter {
* events than count.
* @throws IllegalStateException
* If node was emitted outside unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startUnkeyedListItem(NodeIdentifier name, int childSizeHint) throws IllegalStateException;
+ void startUnkeyedListItem(NodeIdentifier name, int childSizeHint) throws IOException, IllegalStateException;
/**
*
@@ -252,8 +262,9 @@ public interface NormalizedNodeStreamWriter {
* @throws IllegalStateException
* If node was emitted inside map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startMapNode(NodeIdentifier name, int childSizeHint) throws IllegalArgumentException;
+ void startMapNode(NodeIdentifier name, int childSizeHint) throws IOException, IllegalArgumentException;
/**
*
@@ -281,8 +292,9 @@ public interface NormalizedNodeStreamWriter {
* If key contains incorrect value.
* @throws IllegalStateException
* If node was emitted outside map entry
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startMapEntryNode(NodeIdentifierWithPredicates identifier, int childSizeHint) throws IllegalArgumentException;
+ void startMapEntryNode(NodeIdentifierWithPredicates identifier, int childSizeHint) throws IOException, IllegalArgumentException;
/**
*
@@ -301,8 +313,9 @@ public interface NormalizedNodeStreamWriter {
* @throws IllegalStateException
* If node was emitted inside map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startOrderedMapNode(NodeIdentifier name, int childSizeHint) throws IllegalArgumentException;
+ void startOrderedMapNode(NodeIdentifier name, int childSizeHint) throws IOException, IllegalArgumentException;
/**
*
@@ -316,8 +329,9 @@ public interface NormalizedNodeStreamWriter {
* @throws IllegalStateException
* If node was emitted inside map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void startChoiceNode(NodeIdentifier name, int childSizeHint) throws IllegalArgumentException;
+ void startChoiceNode(NodeIdentifier name, int childSizeHint) throws IOException, IllegalArgumentException;
/**
* Emits start of augmentation node.
@@ -341,28 +355,34 @@ public interface NormalizedNodeStreamWriter {
* Augmentation identifier
* @throws IllegalArgumentException
* If augmentation is invalid in current context.
+ * @throws IOException if an underlying IO error occurs
*/
- void startAugmentationNode(AugmentationIdentifier identifier) throws IllegalArgumentException;
+ void startAugmentationNode(AugmentationIdentifier identifier) throws IOException, IllegalArgumentException;
/**
* Emits anyxml node event.
*
- *
* @param name
* @param value
* @throws IllegalArgumentException
* @throws IllegalStateException
* If node was emitted inside map
,
* choice
unkeyed list
node.
+ * @throws IOException if an underlying IO error occurs
*/
- void anyxmlNode(NodeIdentifier name, Object value) throws IllegalArgumentException;
+ void anyxmlNode(NodeIdentifier name, Object value) throws IOException, IllegalArgumentException;
/**
* Emits end event for node.
*
- * @throws IllegalStateException If there is no start* event to be closed.B
- *
+ * @throws IllegalStateException If there is no start* event to be closed.
+ * @throws IOException if an underlying IO error occurs
*/
- void endNode() throws IllegalStateException;
+ void endNode() throws IOException, IllegalStateException;
+
+ @Override
+ void close() throws IOException;
+ @Override
+ void flush() throws IOException;
}