common/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QNameAwareDataInput.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. 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.yangtools.yang.common;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.io.DataInput;
  12 import java.io.IOException;
  13 import org.eclipse.jdt.annotation.NonNull;
  14
  15 /**
  16  * A {@link DataInput} which has an understanding of {@link QName}'s semantics.
  17  */
  18 @Beta
  19 public interface QNameAwareDataInput extends DataInput {
  20     /**
  21      * Read a {@link QName} from the stream.
  22      *
  23      * @return A QName
  24      * @throws IOException if an I/O error occurs.
  25      */
  26     @NonNull QName readQName() throws IOException;
  27 }