• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
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} and {@link MessageLite.Builder} to
35  * 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, all getters for
42    * singular fields will return default values and repeated fields will appear empty. This may or
43    * may not be a singleton. This differs from the {@code getDefaultInstance()} method of generated
44    * message classes in that this method is an abstract method of the {@code MessageLite} interface
45    * whereas {@code getDefaultInstance()} is a static method of a specific class. They return the
46    * same thing.
47    */
getDefaultInstanceForType()48   MessageLite getDefaultInstanceForType();
49 
50   /**
51    * Returns true if all required fields in the message and all embedded messages are set, false
52    * otherwise.
53    *
54    * <p>See also: {@link MessageOrBuilder#getInitializationErrorString()}
55    */
isInitialized()56   boolean isInitialized();
57 }
58