opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeDataInput.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.node.utils.stream;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.io.DataInput;
  12 import java.io.IOException;
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  16 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  17
  18 /**
  19  * Interface for reading {@link NormalizedNode}s, {@link YangInstanceIdentifier}s, {@link PathArgument}s
  20  * and {@link SchemaPath}s.
  21  */
  22 @Beta
  23 public interface NormalizedNodeDataInput extends DataInput {
  24     /**
  25      * Read a normalized node from the reader.
  26      *
  27      * @return Next node from the stream, or null if end of stream has been reached.
  28      * @throws IOException if an error occurs
  29      * @throws IllegalStateException if the dictionary has been detached
  30      */
  31     NormalizedNode<?, ?> readNormalizedNode() throws IOException;
  32
  33     YangInstanceIdentifier readYangInstanceIdentifier() throws IOException;
  34
  35     PathArgument readPathArgument() throws IOException;
  36
  37     SchemaPath readSchemaPath() throws IOException;
  38
  39     /**
  40      * Return the version of the underlying input stream.
  41      *
  42      * @return Stream version
  43      * @throws IOException if the version cannot be ascertained
  44      */
  45     NormalizedNodeStreamVersion getVersion() throws IOException;
  46 }