Reader.java

Go to the documentation of this file.

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
package com.google.protobuf;
 
import java.io.IOException;
import java.util.List;
import java.util.Map;
 
// TODO(nathanmittler): Refactor to allow the reader to allocate properly sized lists.
@ExperimentalApi
interface Reader {
  int READ_DONE = Integer.MAX_VALUE;
 
  int TAG_UNKNOWN = 0;
 
  boolean shouldDiscardUnknownFields();
 
  int getFieldNumber() throws IOException;
 
  int getTag();
 
  boolean skipField() throws IOException;
 
  double readDouble() throws IOException;
 
  float readFloat() throws IOException;
 
  long readUInt64() throws IOException;
 
  long readInt64() throws IOException;
 
  int readInt32() throws IOException;
 
  long readFixed64() throws IOException;
 
  int readFixed32() throws IOException;
 
  boolean readBool() throws IOException;
 
  String readString() throws IOException;
 
  String readStringRequireUtf8() throws IOException;
 
  // TODO(yilunchong): the lack of other opinions for whether to expose this on the interface
  <T> T readMessageBySchemaWithCheck(Schema<T> schema, ExtensionRegistryLite extensionRegistry)
      throws IOException;
 
  <T> T readMessage(Class<T> clazz, ExtensionRegistryLite extensionRegistry) throws IOException;
 
  @Deprecated
  <T> T readGroup(Class<T> clazz, ExtensionRegistryLite extensionRegistry) throws IOException;
 
  // TODO(yilunchong): the lack of other opinions for whether to expose this on the interface
  @Deprecated
  <T> T readGroupBySchemaWithCheck(Schema<T> schema, ExtensionRegistryLite extensionRegistry)
      throws IOException;
 
  ByteString readBytes() throws IOException;
 
  int readUInt32() throws IOException;
 
  int readEnum() throws IOException;
 
  int readSFixed32() throws IOException;
 
  long readSFixed64() throws IOException;
 
  int readSInt32() throws IOException;
 
  long readSInt64() throws IOException;
 
  void readDoubleList(List<Double> target) throws IOException;
 
  void readFloatList(List<Float> target) throws IOException;
 
  void readUInt64List(List<Long> target) throws IOException;
 
  void readInt64List(List<Long> target) throws IOException;
 
  void readInt32List(List<Integer> target) throws IOException;
 
  void readFixed64List(List<Long> target) throws IOException;
 
  void readFixed32List(List<Integer> target) throws IOException;
 
  void readBoolList(List<Boolean> target) throws IOException;
 
  void readStringList(List<String> target) throws IOException;
 
  void readStringListRequireUtf8(List<String> target) throws IOException;
 
  <T> void readMessageList(
      List<T> target, Schema<T> schema, ExtensionRegistryLite extensionRegistry) throws IOException;
 
  <T> void readMessageList(
      List<T> target, Class<T> targetType, ExtensionRegistryLite extensionRegistry)
      throws IOException;
 
  @Deprecated
  <T> void readGroupList(
      List<T> target, Class<T> targetType, ExtensionRegistryLite extensionRegistry)
      throws IOException;
 
  @Deprecated
  <T> void readGroupList(
      List<T> target, Schema<T> targetType, ExtensionRegistryLite extensionRegistry)
      throws IOException;
 
  void readBytesList(List<ByteString> target) throws IOException;
 
  void readUInt32List(List<Integer> target) throws IOException;
 
  void readEnumList(List<Integer> target) throws IOException;
 
  void readSFixed32List(List<Integer> target) throws IOException;
 
  void readSFixed64List(List<Long> target) throws IOException;
 
  void readSInt32List(List<Integer> target) throws IOException;
 
  void readSInt64List(List<Long> target) throws IOException;
 
  <K, V> void readMap(
      Map<K, V> target,
      MapEntryLite.Metadata<K, V> mapDefaultEntry,
      ExtensionRegistryLite extensionRegistry)
      throws IOException;
}