src/third_party/protobuf/java/src/main/java/com/google/protobuf/MessageLiteOrBuilder.java

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 // http://code.google.com/p/protobuf/
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are
   7 // met:
   8 //
   9 //     * Redistributions of source code must retain the above copyright
  10 // notice, this list of conditions and the following disclaimer.
  11 //     * Redistributions in binary form must reproduce the above
  12 // copyright notice, this list of conditions and the following disclaimer
  13 // in the documentation and/or other materials provided with the
  14 // distribution.
  15 //     * Neither the name of Google Inc. nor the names of its
  16 // contributors may be used to endorse or promote products derived from
  17 // this software without specific prior written permission.
  18 //
  19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 package com.google.protobuf;
  32
  33 /**
  34  * Base interface for methods common to {@link MessageLite}
  35  * and {@link MessageLite.Builder} to provide type equivalency.
  36  *
  37  * @author jonp@google.com (Jon Perlow)
  38  */
  39 public interface MessageLiteOrBuilder {
  40   /**
  41    * Get an instance of the type with no fields set. Because no fields are set,
  42    * all getters for singular fields will return default values and repeated
  43    * fields will appear empty.
  44    * This may or may not be a singleton.  This differs from the
  45    * {@code getDefaultInstance()} method of generated message classes in that
  46    * this method is an abstract method of the {@code MessageLite} interface
  47    * whereas {@code getDefaultInstance()} is a static method of a specific
  48    * class.  They return the same thing.
  49    */
  50   MessageLite getDefaultInstanceForType();
  51
  52   /**
  53    * Returns true if all required fields in the message and all embedded
  54    * messages are set, false otherwise.
  55    *
  56    * <p>See also: {@link MessageOrBuilder#getInitializationErrorString()}
  57    */
  58   boolean isInitialized();
  59
  60 }