Message.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.
 
// TODO(kenton):  Use generics?  E.g. Builder<BuilderType extends Builder>, then
//   mergeFrom*() could return BuilderType for better type-safety.
 
package com.google.protobuf;
 
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
 
public interface Message extends MessageLite, MessageOrBuilder {
 
  // (From MessageLite, re-declared here only for return type covariance.)
  @Override
  Parser<? extends Message> getParserForType();
 
 
  // -----------------------------------------------------------------
  // Comparison and hashing
 
  @Override
  boolean equals(Object other);
 
  @Override
  int hashCode();
 
  // -----------------------------------------------------------------
  // Convenience methods.
 
  @Override
  String toString();
 
  // =================================================================
  // Builders
 
  // (From MessageLite, re-declared here only for return type covariance.)
  @Override
  Builder newBuilderForType();
 
  @Override
  Builder toBuilder();
 
  interface Builder extends MessageLite.Builder, MessageOrBuilder {
    // (From MessageLite.Builder, re-declared here only for return type
    // covariance.)
    @Override
    Builder clear();
 
    Builder mergeFrom(Message other);
 
    // (From MessageLite.Builder, re-declared here only for return type
    // covariance.)
    @Override
    Message build();
 
    @Override
    Message buildPartial();
 
    @Override
    Builder clone();
 
    @Override
    Builder mergeFrom(CodedInputStream input) throws IOException;
 
    @Override
    Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
        throws IOException;
 
    @Override
    Descriptors.Descriptor getDescriptorForType();
 
    Builder newBuilderForField(Descriptors.FieldDescriptor field);
 
    Builder getFieldBuilder(Descriptors.FieldDescriptor field);
 
    Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index);
 
    Builder setField(Descriptors.FieldDescriptor field, Object value);
 
    Builder clearField(Descriptors.FieldDescriptor field);
 
    Builder clearOneof(Descriptors.OneofDescriptor oneof);
 
    Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value);
 
    Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value);
 
    Builder setUnknownFields(UnknownFieldSet unknownFields);
 
    Builder mergeUnknownFields(UnknownFieldSet unknownFields);
 
    // ---------------------------------------------------------------
    // Convenience methods.
 
    // (From MessageLite.Builder, re-declared here only for return type
    // covariance.)
    @Override
    Builder mergeFrom(ByteString data) throws InvalidProtocolBufferException;
 
    @Override
    Builder mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
        throws InvalidProtocolBufferException;
 
    @Override
    Builder mergeFrom(byte[] data) throws InvalidProtocolBufferException;
 
    @Override
    Builder mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException;
 
    @Override
    Builder mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
        throws InvalidProtocolBufferException;
 
    @Override
    Builder mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)
        throws InvalidProtocolBufferException;
 
    @Override
    Builder mergeFrom(InputStream input) throws IOException;
 
    @Override
    Builder mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
        throws IOException;
 
    @Override
    boolean mergeDelimitedFrom(InputStream input) throws IOException;
 
    @Override
    boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
        throws IOException;
  }
}