com.google.protobuf

Class GeneratedMessageLite<MessageType extends GeneratedMessageLite<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.Builder<MessageType,BuilderType>>

java.lang.Object

com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>

com.google.protobuf.GeneratedMessageLite<MessageType,BuilderType>

Type Parameters:

MessageType - the type of the message.

BuilderType - the type of the builder.

All Implemented Interfaces:

MessageLite, MessageLiteOrBuilder

Direct Known Subclasses:

GeneratedMessageLite.ExtendableMessage

public abstract class GeneratedMessageLite<MessageType extends GeneratedMessageLite<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.Builder<MessageType,BuilderType>>
extends AbstractMessageLite<MessageType,BuilderType>

All generated protocol message classes extend this class. This class implements most of the MessageLite and Builder interfaces. Users can ignore this class and pretend that generated messages implement the Message interface directly.

Author:

kenton@google.com Kenton Varda

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneratedMessageLite.Builder<MessageType extends GeneratedMessageLite<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.Builder<MessageType,BuilderType>>
protected static class	GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,?>> A Parser implementation that delegates to the default instance.
static class	GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>> Generated message builders for message types that contain extension ranges subclass this.
static class	GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>> Generated message classes for message types that contain extension ranges subclass this.
static interface	GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>
static class	GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite,Type> Type used to represent generated extensions.
protected static class	GeneratedMessageLite.MergeFromVisitor Implements field merging semantics over the visitor interface.
static class	GeneratedMessageLite.MethodToInvoke Defines which method path to invoke in #dynamicMethod(MethodToInvoke, Object...).
protected static class	GeneratedMessageLite.SerializedForm A serialized (serializable) form of the generated message.
protected static interface	GeneratedMessageLite.Visitor An abstract visitor that the generated code calls into that we use to implement various features.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	memoizedSerializedSize For use by generated code only.
protected UnknownFieldSetLite	unknownFields For use by generated code only.

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Constructor and Description
GeneratedMessageLite()

Method Summary

Modifier and Type	Method and Description
protected Object	dynamicMethod(GeneratedMessageLite.MethodToInvoke method) Same as dynamicMethod(MethodToInvoke, Object, Object) with null padding.
protected Object	dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0) Same as dynamicMethod(MethodToInvoke, Object, Object) with null padding.
protected abstract Object	dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke.
protected static Internal.BooleanList	emptyBooleanList()
protected static Internal.DoubleList	emptyDoubleList()
protected static Internal.FloatList	emptyFloatList()
protected static Internal.IntList	emptyIntList()
protected static Internal.LongList	emptyLongList()
protected static <E> Internal.ProtobufList<E>	emptyProtobufList()
boolean	equals(Object other) Indicates whether some other object is "equal to" this one.
MessageType	getDefaultInstanceForType() Get an instance of the type with no fields set.
Parser<MessageType>	getParserForType() Gets the parser for a message of the same type as this message.
int	hashCode() Returns a hash code value for the object.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
protected static <T extends GeneratedMessageLite<T,?>> boolean	isInitialized(T message, boolean shouldMemoize) A static helper method for checking if a message is initialized, optionally memoizing.
protected void	makeImmutable() Called by subclasses to complete parsing.
protected static <T extends GeneratedMessageLite<T,?>> void	makeImmutable(T message)
protected void	mergeLengthDelimitedField(int fieldNumber, ByteString value) Called by subclasses to parse an unknown field.
protected void	mergeUnknownFields(UnknownFieldSetLite unknownFields) Merge some unknown fields into the UnknownFieldSetLite for this message.
protected void	mergeVarintField(int tag, int value) Called by subclasses to parse an unknown field.
protected static Internal.BooleanList	mutableCopy(Internal.BooleanList list)
protected static Internal.DoubleList	mutableCopy(Internal.DoubleList list)
protected static Internal.FloatList	mutableCopy(Internal.FloatList list)
protected static Internal.IntList	mutableCopy(Internal.IntList list)
protected static Internal.LongList	mutableCopy(Internal.LongList list)
protected static <E> Internal.ProtobufList<E>	mutableCopy(Internal.ProtobufList<E> list)
BuilderType	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static <ContainingType extends MessageLite,Type> GeneratedMessageLite.GeneratedExtension<ContainingType,Type>	newRepeatedGeneratedExtension(ContainingType containingTypeDefaultInstance, MessageLite messageDefaultInstance, Internal.EnumLiteMap<?> enumTypeMap, int number, WireFormat.FieldType type, boolean isPacked, Class singularType) For use by generated code only.
static <ContainingType extends MessageLite,Type> GeneratedMessageLite.GeneratedExtension<ContainingType,Type>	newSingularGeneratedExtension(ContainingType containingTypeDefaultInstance, Type defaultValue, MessageLite messageDefaultInstance, Internal.EnumLiteMap<?> enumTypeMap, int number, WireFormat.FieldType type, Class singularType) For use by generated code only.
protected static <T extends GeneratedMessageLite<T,?>> T	parseDelimitedFrom(T defaultInstance, InputStream input)
protected static <T extends GeneratedMessageLite<T,?>> T	parseDelimitedFrom(T defaultInstance, InputStream input, ExtensionRegistryLite extensionRegistry)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, byte[] data)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, byte[] data, ExtensionRegistryLite extensionRegistry)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, ByteString data)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, ByteString data, ExtensionRegistryLite extensionRegistry)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, CodedInputStream input)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, CodedInputStream input, ExtensionRegistryLite extensionRegistry)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, InputStream input)
protected static <T extends GeneratedMessageLite<T,?>> T	parseFrom(T defaultInstance, InputStream input, ExtensionRegistryLite extensionRegistry)
protected static <T extends GeneratedMessageLite<T,?>> T	parsePartialFrom(T defaultInstance, CodedInputStream input)
protected boolean	parseUnknownField(int tag, CodedInputStream input) Called by subclasses to parse an unknown field.
BuilderType	toBuilder() Constructs a builder initialized with the current message.

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

getSerializedSize, writeTo

Field Detail

memoizedSerializedSize

protected int memoizedSerializedSize

For use by generated code only.

unknownFields

protected UnknownFieldSetLite unknownFields

For use by generated code only. Lazily initialized to reduce allocations.

Constructor Detail

GeneratedMessageLite

public GeneratedMessageLite()

Method Detail

dynamicMethod

@Nullable
protected Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method)

Same as dynamicMethod(MethodToInvoke, Object, Object) with null padding.

dynamicMethod

@Nullable
protected Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
                                         Object arg0)

Same as dynamicMethod(MethodToInvoke, Object, Object) with null padding.

dynamicMethod

@Nullable
protected abstract Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
                                                  @Nullable
                                                  Object arg0,
                                                  @Nullable
                                                  Object arg1)

A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke. Theses different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.

• MERGE_FROM_STREAM is parameterized with an CodedInputStream and ExtensionRegistryLite. It consumes the input stream, parsing the contents into the returned protocol buffer. If parsing throws an InvalidProtocolBufferException, the implementation wraps it in a RuntimeException.
• NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
• IS_INITIALIZED is parameterized with a Boolean detailing whether to memoize. It returns null for false and the default instance for true. We optionally memoize to support the Builder case, where memoization is not desired.
• NEW_BUILDER returns a BuilderType instance.
• VISIT is parameterized with a Visitor and a MessageType and recursively iterates through the fields side by side between this and the instance.
• MAKE_IMMUTABLE sets all internal fields to an immutable state.

For use by generated code only.

emptyBooleanList

protected static Internal.BooleanList emptyBooleanList()

emptyDoubleList

protected static Internal.DoubleList emptyDoubleList()

emptyFloatList

protected static Internal.FloatList emptyFloatList()

emptyIntList

protected static Internal.IntList emptyIntList()

emptyLongList

protected static Internal.LongList emptyLongList()

emptyProtobufList

protected static <E> Internal.ProtobufList<E> emptyProtobufList()

equals

public boolean equals(@Nullable
                      Object other)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

other - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

getDefaultInstanceForType

public final MessageType getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

getParserForType

public final Parser<MessageType> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

isInitialized

protected static final <T extends GeneratedMessageLite<T,?>> boolean isInitialized(T message,
                                                                                   boolean shouldMemoize)

A static helper method for checking if a message is initialized, optionally memoizing.

For use by generated code only.

makeImmutable

protected void makeImmutable()

Called by subclasses to complete parsing. For use by generated code only.

makeImmutable

protected static final <T extends GeneratedMessageLite<T,?>> void makeImmutable(T message)

mergeLengthDelimitedField

protected void mergeLengthDelimitedField(int fieldNumber,
                                         ByteString value)

Called by subclasses to parse an unknown field. For use by generated code only.

mergeUnknownFields

protected final void mergeUnknownFields(UnknownFieldSetLite unknownFields)

Merge some unknown fields into the UnknownFieldSetLite for this message.

For use by generated code only.

mergeVarintField

protected void mergeVarintField(int tag,
                                int value)

Called by subclasses to parse an unknown field. For use by generated code only.

mutableCopy

protected static Internal.BooleanList mutableCopy(Internal.BooleanList list)

mutableCopy

protected static Internal.DoubleList mutableCopy(Internal.DoubleList list)

mutableCopy

protected static Internal.FloatList mutableCopy(Internal.FloatList list)

mutableCopy

protected static Internal.IntList mutableCopy(Internal.IntList list)

mutableCopy

protected static Internal.LongList mutableCopy(Internal.LongList list)

mutableCopy

protected static <E> Internal.ProtobufList<E> mutableCopy(Internal.ProtobufList<E> list)

newBuilderForType

public final BuilderType newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

newRepeatedGeneratedExtension

public static <ContainingType extends MessageLite,Type> GeneratedMessageLite.GeneratedExtension<ContainingType,Type> newRepeatedGeneratedExtension(ContainingType containingTypeDefaultInstance,
                                                                                                                                                   MessageLite messageDefaultInstance,
                                                                                                                                                   Internal.EnumLiteMap<?> enumTypeMap,
                                                                                                                                                   int number,
                                                                                                                                                   WireFormat.FieldType type,
                                                                                                                                                   boolean isPacked,
                                                                                                                                                   Class singularType)

For use by generated code only.

newSingularGeneratedExtension

public static <ContainingType extends MessageLite,Type> GeneratedMessageLite.GeneratedExtension<ContainingType,Type> newSingularGeneratedExtension(ContainingType containingTypeDefaultInstance,
                                                                                                                                                   Type defaultValue,
                                                                                                                                                   MessageLite messageDefaultInstance,
                                                                                                                                                   Internal.EnumLiteMap<?> enumTypeMap,
                                                                                                                                                   int number,
                                                                                                                                                   WireFormat.FieldType type,
                                                                                                                                                   Class singularType)

For use by generated code only.

parseDelimitedFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseDelimitedFrom(T defaultInstance,
                                                                            InputStream input)
                                                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseDelimitedFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseDelimitedFrom(T defaultInstance,
                                                                            InputStream input,
                                                                            ExtensionRegistryLite extensionRegistry)
                                                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   byte[] data)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   byte[] data,
                                                                   ExtensionRegistryLite extensionRegistry)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   ByteString data)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   ByteString data,
                                                                   ExtensionRegistryLite extensionRegistry)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   CodedInputStream input)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   CodedInputStream input,
                                                                   ExtensionRegistryLite extensionRegistry)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   InputStream input)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

protected static <T extends GeneratedMessageLite<T,?>> T parseFrom(T defaultInstance,
                                                                   InputStream input,
                                                                   ExtensionRegistryLite extensionRegistry)
                                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parsePartialFrom

protected static <T extends GeneratedMessageLite<T,?>> T parsePartialFrom(T defaultInstance,
                                                                          CodedInputStream input)
                                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseUnknownField

protected boolean parseUnknownField(int tag,
                                    CodedInputStream input)
                             throws IOException

Called by subclasses to parse an unknown field. For use by generated code only.

Returns:

true unless the tag is an end-group tag.

Throws:

IOException

toBuilder

public final BuilderType toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.