com.google.protobuf
Class GeneratedMessage.Builder<BuilderType extends GeneratedMessage.Builder>
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<BuilderType>
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessage.Builder<BuilderType>
- All Implemented Interfaces:
- Message.Builder, MessageLite.Builder, Cloneable
- Direct Known Subclasses:
- DescriptorProtos.DescriptorProto.Builder, DescriptorProtos.DescriptorProto.ExtensionRange.Builder, DescriptorProtos.EnumDescriptorProto.Builder, DescriptorProtos.EnumValueDescriptorProto.Builder, DescriptorProtos.FieldDescriptorProto.Builder, DescriptorProtos.FileDescriptorProto.Builder, DescriptorProtos.FileDescriptorSet.Builder, DescriptorProtos.MethodDescriptorProto.Builder, DescriptorProtos.ServiceDescriptorProto.Builder, DescriptorProtos.UninterpretedOption.Builder, DescriptorProtos.UninterpretedOption.NamePart.Builder, GeneratedMessage.ExtendableBuilder
- Enclosing class:
- GeneratedMessage
public abstract static class GeneratedMessage.Builder<BuilderType extends GeneratedMessage.Builder>
- extends AbstractMessage.Builder<BuilderType>
Method Summary |
BuilderType |
addRepeatedField(Descriptors.FieldDescriptor field,
Object value)
Like setRepeatedField , but appends the value as a new element. |
BuilderType |
clearField(Descriptors.FieldDescriptor field)
Clears the field. |
BuilderType |
clone()
Clones the Builder. |
Map<Descriptors.FieldDescriptor,Object> |
getAllFields()
Like Message.getAllFields() . |
Descriptors.Descriptor |
getDescriptorForType()
Get the message's type's descriptor. |
Object |
getField(Descriptors.FieldDescriptor field)
Like Message.getField(Descriptors.FieldDescriptor) |
Object |
getRepeatedField(Descriptors.FieldDescriptor field,
int index)
Like Message.getRepeatedField(Descriptors.FieldDescriptor,int) |
int |
getRepeatedFieldCount(Descriptors.FieldDescriptor field)
Like Message.getRepeatedFieldCount(Descriptors.FieldDescriptor) |
UnknownFieldSet |
getUnknownFields()
Get the UnknownFieldSet for this message. |
boolean |
hasField(Descriptors.FieldDescriptor field)
Like Message.hasField(Descriptors.FieldDescriptor) |
protected abstract GeneratedMessage |
internalGetResult()
Get the message being built. |
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded
messages are set, false otherwise. |
BuilderType |
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into the UnknownFieldSet for this
message. |
Message.Builder |
newBuilderForField(Descriptors.FieldDescriptor field)
Create a Builder for messages of the appropriate type for the given
field. |
protected boolean |
parseUnknownField(CodedInputStream input,
UnknownFieldSet.Builder unknownFields,
ExtensionRegistryLite extensionRegistry,
int tag)
Called by subclasses to parse an unknown field. |
BuilderType |
setField(Descriptors.FieldDescriptor field,
Object value)
Sets a field to the given value. |
BuilderType |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value)
Sets an element of a repeated field to the given value. |
BuilderType |
setUnknownFields(UnknownFieldSet unknownFields)
Set the UnknownFieldSet for this message. |
Methods inherited from class com.google.protobuf.AbstractMessage.Builder |
clear, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException |
GeneratedMessage.Builder
protected GeneratedMessage.Builder()
clone
public BuilderType clone()
- Description copied from interface:
MessageLite.Builder
- Clones the Builder.
- Specified by:
clone
in interface Message.Builder
- Specified by:
clone
in interface MessageLite.Builder
- Specified by:
clone
in class AbstractMessage.Builder<BuilderType extends GeneratedMessage.Builder>
- See Also:
Object.clone()
internalGetResult
protected abstract GeneratedMessage internalGetResult()
- Get the message being built. We don't just pass this to the
constructor because it becomes null when build() is called.
getDescriptorForType
public Descriptors.Descriptor getDescriptorForType()
- Description copied from interface:
Message.Builder
- Get the message's type's descriptor.
See
Message.getDescriptorForType()
.
getAllFields
public Map<Descriptors.FieldDescriptor,Object> getAllFields()
- Description copied from interface:
Message.Builder
- Like
Message.getAllFields()
. The returned map may or may not
reflect future changes to the builder. Either way, the returned map is
itself unmodifiable.
newBuilderForField
public Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)
- Description copied from interface:
Message.Builder
- Create a Builder for messages of the appropriate type for the given
field. Messages built with this can then be passed to setField(),
setRepeatedField(), or addRepeatedField().
hasField
public boolean hasField(Descriptors.FieldDescriptor field)
- Description copied from interface:
Message.Builder
- Like
Message.hasField(Descriptors.FieldDescriptor)
getField
public Object getField(Descriptors.FieldDescriptor field)
- Description copied from interface:
Message.Builder
- Like
Message.getField(Descriptors.FieldDescriptor)
setField
public BuilderType setField(Descriptors.FieldDescriptor field,
Object value)
- Description copied from interface:
Message.Builder
- Sets a field to the given value. The value must be of the correct type
for this field, i.e. the same type that
Message.getField(Descriptors.FieldDescriptor)
would return.
clearField
public BuilderType clearField(Descriptors.FieldDescriptor field)
- Description copied from interface:
Message.Builder
- Clears the field. This is exactly equivalent to calling the generated
"clear" accessor method corresponding to the field.
getRepeatedFieldCount
public int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
- Description copied from interface:
Message.Builder
- Like
Message.getRepeatedFieldCount(Descriptors.FieldDescriptor)
getRepeatedField
public Object getRepeatedField(Descriptors.FieldDescriptor field,
int index)
- Description copied from interface:
Message.Builder
- Like
Message.getRepeatedField(Descriptors.FieldDescriptor,int)
setRepeatedField
public BuilderType setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value)
- Description copied from interface:
Message.Builder
- Sets an element of a repeated field to the given value. The value must
be of the correct type for this field, i.e. the same type that
Message.getRepeatedField(Descriptors.FieldDescriptor,int)
would
return.
addRepeatedField
public BuilderType addRepeatedField(Descriptors.FieldDescriptor field,
Object value)
- Description copied from interface:
Message.Builder
- Like
setRepeatedField
, but appends the value as a new element.
getUnknownFields
public final UnknownFieldSet getUnknownFields()
- Description copied from interface:
Message.Builder
- Get the
UnknownFieldSet
for this message.
setUnknownFields
public final BuilderType setUnknownFields(UnknownFieldSet unknownFields)
- Description copied from interface:
Message.Builder
- Set the
UnknownFieldSet
for this message.
mergeUnknownFields
public final BuilderType mergeUnknownFields(UnknownFieldSet unknownFields)
- Description copied from interface:
Message.Builder
- Merge some unknown fields into the
UnknownFieldSet
for this
message.
- Specified by:
mergeUnknownFields
in interface Message.Builder
- Overrides:
mergeUnknownFields
in class AbstractMessage.Builder<BuilderType extends GeneratedMessage.Builder>
isInitialized
public boolean isInitialized()
- Description copied from interface:
MessageLite.Builder
- Returns true if all required fields in the message and all embedded
messages are set, false otherwise.
parseUnknownField
protected boolean parseUnknownField(CodedInputStream input,
UnknownFieldSet.Builder unknownFields,
ExtensionRegistryLite extensionRegistry,
int tag)
throws IOException
- Called by subclasses to parse an unknown field.
- Returns:
true
unless the tag is an end-group tag.
- Throws:
IOException
Copyright © 2008-2011. All Rights Reserved.