Package com.google.protobuf
Class DescriptorProtos.FieldDescriptorProto
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.DescriptorProtos.FieldDescriptorProto
- All Implemented Interfaces:
DescriptorProtos.FieldDescriptorProtoOrBuilder
,Message
,MessageLite
,MessageLiteOrBuilder
,MessageOrBuilder
,Serializable
- Enclosing class:
- DescriptorProtos
public static final class DescriptorProtos.FieldDescriptorProto
extends GeneratedMessage
implements DescriptorProtos.FieldDescriptorProtoOrBuilder
Protobuf type
google.protobuf.FieldDescriptorProto
Describes a field within a message.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Protobuf typegoogle.protobuf.FieldDescriptorProto
static enum
Protobuf enumgoogle.protobuf.FieldDescriptorProto.Label
static enum
Protobuf enumgoogle.protobuf.FieldDescriptorProto.Type
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
GeneratedMessage.BuilderParent, GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,
BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message, Type> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionGet an instance of the type with no fields set.optional string default_value = 7;
optional string default_value = 7;
static final Descriptors.Descriptor
optional string extendee = 2;
optional string extendee = 2;
getLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
getName()
optional string name = 1;
optional string name = 1;
int
optional int32 number = 3;
int
optional int32 oneof_index = 9;
optional .google.protobuf.FieldOptions options = 8;
optional .google.protobuf.FieldOptions options = 8;
Gets the parser for a message of the same type as this message.int
Get the number of bytes required to encode this message.getType()
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
optional string type_name = 6;
optional string type_name = 6;
final UnknownFieldSet
Get theUnknownFieldSet
for this message.boolean
optional string default_value = 7;
boolean
optional string extendee = 2;
boolean
hasLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
boolean
hasName()
optional string name = 1;
boolean
optional int32 number = 3;
boolean
optional int32 oneof_index = 9;
boolean
optional .google.protobuf.FieldOptions options = 8;
boolean
hasType()
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
boolean
optional string type_name = 6;
protected GeneratedMessage.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.newBuilder
(DescriptorProtos.FieldDescriptorProto prototype) Constructs a new builder for a message of the same type as this message.parseDelimitedFrom
(InputStream input) parseDelimitedFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom
(byte[] data) parseFrom
(byte[] data, ExtensionRegistryLite extensionRegistry) parseFrom
(ByteString data) parseFrom
(ByteString data, ExtensionRegistryLite extensionRegistry) parseFrom
(CodedInputStream input) parseFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) parseFrom
(InputStream input) parseFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) Constructs a builder initialized with the current message.protected Object
Replaces this object in the output stream with a serialized form.void
writeTo
(CodedOutputStream output) Serializes the message and writes it tooutput
.Methods inherited from class com.google.protobuf.GeneratedMessage
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField
Methods inherited from class com.google.protobuf.AbstractMessage
equals, findInitializationErrors, getInitializationErrorString, hashCode, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
PARSER
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
NUMBER_FIELD_NUMBER
public static final int NUMBER_FIELD_NUMBER- See Also:
-
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
TYPE_NAME_FIELD_NUMBER
public static final int TYPE_NAME_FIELD_NUMBER- See Also:
-
EXTENDEE_FIELD_NUMBER
public static final int EXTENDEE_FIELD_NUMBER- See Also:
-
DEFAULT_VALUE_FIELD_NUMBER
public static final int DEFAULT_VALUE_FIELD_NUMBER- See Also:
-
ONEOF_INDEX_FIELD_NUMBER
public static final int ONEOF_INDEX_FIELD_NUMBER- See Also:
-
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDefaultInstance
-
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 thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-
getUnknownFields
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message.- Specified by:
getUnknownFields
in interfaceMessageOrBuilder
- Overrides:
getUnknownFields
in classGeneratedMessage
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessage
Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTable
in classGeneratedMessage
-
getParserForType
Description copied from interface:MessageLite
Gets the parser for a message of the same type as this message.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classGeneratedMessage
-
hasName
public boolean hasName()optional string name = 1;
- Specified by:
hasName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getName
optional string name = 1;
- Specified by:
getName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getNameBytes
optional string name = 1;
- Specified by:
getNameBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasNumber
public boolean hasNumber()optional int32 number = 3;
- Specified by:
hasNumber
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getNumber
public int getNumber()optional int32 number = 3;
- Specified by:
getNumber
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasLabel
public boolean hasLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Specified by:
hasLabel
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getLabel
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Specified by:
getLabel
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasType
public boolean hasType()optional .google.protobuf.FieldDescriptorProto.Type type = 5;
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
- Specified by:
hasType
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getType
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
- Specified by:
getType
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasTypeName
public boolean hasTypeName()optional string type_name = 6;
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
- Specified by:
hasTypeName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getTypeName
optional string type_name = 6;
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
- Specified by:
getTypeName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getTypeNameBytes
optional string type_name = 6;
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
- Specified by:
getTypeNameBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasExtendee
public boolean hasExtendee()optional string extendee = 2;
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
- Specified by:
hasExtendee
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getExtendee
optional string extendee = 2;
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
- Specified by:
getExtendee
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getExtendeeBytes
optional string extendee = 2;
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
- Specified by:
getExtendeeBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasDefaultValue
public boolean hasDefaultValue()optional string default_value = 7;
For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
- Specified by:
hasDefaultValue
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getDefaultValue
optional string default_value = 7;
For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
- Specified by:
getDefaultValue
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getDefaultValueBytes
optional string default_value = 7;
For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
- Specified by:
getDefaultValueBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasOneofIndex
public boolean hasOneofIndex()optional int32 oneof_index = 9;
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Extensions of a oneof should not set this since the oneof to which they belong will be inferred based on the extension range containing the extension's field number.
- Specified by:
hasOneofIndex
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getOneofIndex
public int getOneofIndex()optional int32 oneof_index = 9;
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Extensions of a oneof should not set this since the oneof to which they belong will be inferred based on the extension range containing the extension's field number.
- Specified by:
getOneofIndex
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
hasOptions
public boolean hasOptions()optional .google.protobuf.FieldOptions options = 8;
- Specified by:
hasOptions
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getOptions
optional .google.protobuf.FieldOptions options = 8;
- Specified by:
getOptions
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getOptionsOrBuilder
optional .google.protobuf.FieldOptions options = 8;
- Specified by:
getOptionsOrBuilder
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessage
-
writeTo
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Overrides:
writeTo
in classAbstractMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLite
Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.- Specified by:
getSerializedSize
in interfaceMessageLite
- Overrides:
getSerializedSize
in classAbstractMessage
-
writeReplace
Description copied from class:GeneratedMessage
Replaces this object in the output stream with a serialized form. Part of Java's serialization magic. Generated sub-classes must override this method by callingreturn super.writeReplace();
- Overrides:
writeReplace
in classGeneratedMessage
- Returns:
- a SerializedForm of this message
- Throws:
ObjectStreamException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(ByteString data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(byte[] data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static DescriptorProtos.FieldDescriptorProto parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static DescriptorProtos.FieldDescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static DescriptorProtos.FieldDescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilderForType
Description copied from interface:MessageLite
Constructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForType
in interfaceMessage
- Specified by:
newBuilderForType
in interfaceMessageLite
-
newBuilder
public static DescriptorProtos.FieldDescriptorProto.Builder newBuilder(DescriptorProtos.FieldDescriptorProto prototype) -
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.- Specified by:
toBuilder
in interfaceMessage
- Specified by:
toBuilder
in interfaceMessageLite
-
newBuilderForType
protected DescriptorProtos.FieldDescriptorProto.Builder newBuilderForType(GeneratedMessage.BuilderParent parent) - Specified by:
newBuilderForType
in classGeneratedMessage
-