Class DescriptorProtos.DescriptorProto

public static final class DescriptorProtos.DescriptorProto extends GeneratedMessageV3 implements DescriptorProtos.DescriptorProtoOrBuilder

Describes a message type.

Protobuf type google.protobuf.DescriptorProto

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DescriptorProtos.DescriptorProto

Static Fields

ENUM_TYPE_FIELD_NUMBER

public static final int ENUM_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

EXTENSION_FIELD_NUMBER

public static final int EXTENSION_FIELD_NUMBER
Field Value
TypeDescription
int

EXTENSION_RANGE_FIELD_NUMBER

public static final int EXTENSION_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NESTED_TYPE_FIELD_NUMBER

public static final int NESTED_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

ONEOF_DECL_FIELD_NUMBER

public static final int ONEOF_DECL_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PARSER

public static final Parser<DescriptorProtos.DescriptorProto> PARSER
Field Value
TypeDescription
Parser<DescriptorProto>

RESERVED_NAME_FIELD_NUMBER

public static final int RESERVED_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVED_RANGE_FIELD_NUMBER

public static final int RESERVED_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DescriptorProtos.DescriptorProto getDefaultInstance()
Returns
TypeDescription
DescriptorProtos.DescriptorProto

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptors.Descriptor

newBuilder()

public static DescriptorProtos.DescriptorProto.Builder newBuilder()
Returns
TypeDescription
DescriptorProtos.DescriptorProto.Builder

newBuilder(DescriptorProtos.DescriptorProto prototype)

public static DescriptorProtos.DescriptorProto.Builder newBuilder(DescriptorProtos.DescriptorProto prototype)
Parameter
NameDescription
prototypeDescriptorProtos.DescriptorProto
Returns
TypeDescription
DescriptorProtos.DescriptorProto.Builder

parseDelimitedFrom(InputStream input)

public static DescriptorProtos.DescriptorProto parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.DescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DescriptorProtos.DescriptorProto parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.DescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DescriptorProtos.DescriptorProto parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.DescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DescriptorProtos.DescriptorProto parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.DescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DescriptorProtos.DescriptorProto parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.DescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DescriptorProtos.DescriptorProto parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.DescriptorProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.DescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DescriptorProtos.DescriptorProto> parser()
Returns
TypeDescription
Parser<DescriptorProto>

Methods

equals(Object obj)

public boolean equals(Object obj)

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DescriptorProtos.DescriptorProto getDefaultInstanceForType()

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.

Returns
TypeDescription
DescriptorProtos.DescriptorProto

getEnumType(int index)

public DescriptorProtos.EnumDescriptorProto getEnumType(int index)

repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto

getEnumTypeCount()

public int getEnumTypeCount()

repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Returns
TypeDescription
int

getEnumTypeList()

public List<DescriptorProtos.EnumDescriptorProto> getEnumTypeList()

repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Returns
TypeDescription
List<EnumDescriptorProto>

getEnumTypeOrBuilder(int index)

public DescriptorProtos.EnumDescriptorProtoOrBuilder getEnumTypeOrBuilder(int index)

repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProtoOrBuilder

getEnumTypeOrBuilderList()

public List<? extends DescriptorProtos.EnumDescriptorProtoOrBuilder> getEnumTypeOrBuilderList()

repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.EnumDescriptorProtoOrBuilder>

getExtension(int index)

public DescriptorProtos.FieldDescriptorProto getExtension(int index)

repeated .google.protobuf.FieldDescriptorProto extension = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FieldDescriptorProto

getExtensionCount()

public int getExtensionCount()

repeated .google.protobuf.FieldDescriptorProto extension = 6;

Returns
TypeDescription
int

getExtensionList()

public List<DescriptorProtos.FieldDescriptorProto> getExtensionList()

repeated .google.protobuf.FieldDescriptorProto extension = 6;

Returns
TypeDescription
List<FieldDescriptorProto>

getExtensionOrBuilder(int index)

public DescriptorProtos.FieldDescriptorProtoOrBuilder getExtensionOrBuilder(int index)

repeated .google.protobuf.FieldDescriptorProto extension = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FieldDescriptorProtoOrBuilder

getExtensionOrBuilderList()

public List<? extends DescriptorProtos.FieldDescriptorProtoOrBuilder> getExtensionOrBuilderList()

repeated .google.protobuf.FieldDescriptorProto extension = 6;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.FieldDescriptorProtoOrBuilder>

getExtensionRange(int index)

public DescriptorProtos.DescriptorProto.ExtensionRange getExtensionRange(int index)

repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.DescriptorProto.ExtensionRange

getExtensionRangeCount()

public int getExtensionRangeCount()

repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Returns
TypeDescription
int

getExtensionRangeList()

public List<DescriptorProtos.DescriptorProto.ExtensionRange> getExtensionRangeList()

repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Returns
TypeDescription
List<ExtensionRange>

getExtensionRangeOrBuilder(int index)

public DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder getExtensionRangeOrBuilder(int index)

repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder

getExtensionRangeOrBuilderList()

public List<? extends DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder> getExtensionRangeOrBuilderList()

repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder>

getField(int index)

public DescriptorProtos.FieldDescriptorProto getField(int index)

repeated .google.protobuf.FieldDescriptorProto field = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FieldDescriptorProto

getFieldCount()

public int getFieldCount()

repeated .google.protobuf.FieldDescriptorProto field = 2;

Returns
TypeDescription
int

getFieldList()

public List<DescriptorProtos.FieldDescriptorProto> getFieldList()

repeated .google.protobuf.FieldDescriptorProto field = 2;

Returns
TypeDescription
List<FieldDescriptorProto>

getFieldOrBuilder(int index)

public DescriptorProtos.FieldDescriptorProtoOrBuilder getFieldOrBuilder(int index)

repeated .google.protobuf.FieldDescriptorProto field = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FieldDescriptorProtoOrBuilder

getFieldOrBuilderList()

public List<? extends DescriptorProtos.FieldDescriptorProtoOrBuilder> getFieldOrBuilderList()

repeated .google.protobuf.FieldDescriptorProto field = 2;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.FieldDescriptorProtoOrBuilder>

getName()

public String getName()

optional string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

optional string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getNestedType(int index)

public DescriptorProtos.DescriptorProto getNestedType(int index)

repeated .google.protobuf.DescriptorProto nested_type = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.DescriptorProto

getNestedTypeCount()

public int getNestedTypeCount()

repeated .google.protobuf.DescriptorProto nested_type = 3;

Returns
TypeDescription
int

getNestedTypeList()

public List<DescriptorProtos.DescriptorProto> getNestedTypeList()

repeated .google.protobuf.DescriptorProto nested_type = 3;

Returns
TypeDescription
List<DescriptorProto>

getNestedTypeOrBuilder(int index)

public DescriptorProtos.DescriptorProtoOrBuilder getNestedTypeOrBuilder(int index)

repeated .google.protobuf.DescriptorProto nested_type = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.DescriptorProtoOrBuilder

getNestedTypeOrBuilderList()

public List<? extends DescriptorProtos.DescriptorProtoOrBuilder> getNestedTypeOrBuilderList()

repeated .google.protobuf.DescriptorProto nested_type = 3;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.DescriptorProtoOrBuilder>

getOneofDecl(int index)

public DescriptorProtos.OneofDescriptorProto getOneofDecl(int index)

repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.OneofDescriptorProto

getOneofDeclCount()

public int getOneofDeclCount()

repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Returns
TypeDescription
int

getOneofDeclList()

public List<DescriptorProtos.OneofDescriptorProto> getOneofDeclList()

repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Returns
TypeDescription
List<OneofDescriptorProto>

getOneofDeclOrBuilder(int index)

public DescriptorProtos.OneofDescriptorProtoOrBuilder getOneofDeclOrBuilder(int index)

repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.OneofDescriptorProtoOrBuilder

getOneofDeclOrBuilderList()

public List<? extends DescriptorProtos.OneofDescriptorProtoOrBuilder> getOneofDeclOrBuilderList()

repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.OneofDescriptorProtoOrBuilder>

getOptions()

public DescriptorProtos.MessageOptions getOptions()

optional .google.protobuf.MessageOptions options = 7;

Returns
TypeDescription
DescriptorProtos.MessageOptions

The options.

getOptionsOrBuilder()

public DescriptorProtos.MessageOptionsOrBuilder getOptionsOrBuilder()

optional .google.protobuf.MessageOptions options = 7;

Returns
TypeDescription
DescriptorProtos.MessageOptionsOrBuilder

getParserForType()

public Parser<DescriptorProtos.DescriptorProto> getParserForType()
Returns
TypeDescription
Parser<DescriptorProto>
Overrides

getReservedName(int index)

public String getReservedName(int index)

Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

repeated string reserved_name = 10;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The reservedName at the given index.

getReservedNameBytes(int index)

public ByteString getReservedNameBytes(int index)

Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

repeated string reserved_name = 10;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the reservedName at the given index.

getReservedNameCount()

public int getReservedNameCount()

Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

repeated string reserved_name = 10;

Returns
TypeDescription
int

The count of reservedName.

getReservedNameList()

public ProtocolStringList getReservedNameList()

Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

repeated string reserved_name = 10;

Returns
TypeDescription
ProtocolStringList

A list containing the reservedName.

getReservedRange(int index)

public DescriptorProtos.DescriptorProto.ReservedRange getReservedRange(int index)

repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.DescriptorProto.ReservedRange

getReservedRangeCount()

public int getReservedRangeCount()

repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Returns
TypeDescription
int

getReservedRangeList()

public List<DescriptorProtos.DescriptorProto.ReservedRange> getReservedRangeList()

repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Returns
TypeDescription
List<ReservedRange>

getReservedRangeOrBuilder(int index)

public DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder getReservedRangeOrBuilder(int index)

repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder

getReservedRangeOrBuilderList()

public List<? extends DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder> getReservedRangeOrBuilderList()

repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder>

getSerializedSize()

public int getSerializedSize()

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
TypeDescription
UnknownFieldSet
Overrides

hasName()

public boolean hasName()

optional string name = 1;

Returns
TypeDescription
boolean

Whether the name field is set.

hasOptions()

public boolean hasOptions()

optional .google.protobuf.MessageOptions options = 7;

Returns
TypeDescription
boolean

Whether the options field is set.

hashCode()

public int hashCode()

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

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.

Returns
TypeDescription
GeneratedMessageV3.FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()

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

See also: MessageOrBuilder#getInitializationErrorString()

Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DescriptorProtos.DescriptorProto.Builder newBuilderForType()
Returns
TypeDescription
DescriptorProtos.DescriptorProto.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DescriptorProtos.DescriptorProto.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Parameter
NameDescription
parentGeneratedMessageV3.BuilderParent
Returns
TypeDescription
DescriptorProtos.DescriptorProto.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Creates a new instance of this message type. Overridden in the generated code.

Parameter
NameDescription
unusedGeneratedMessageV3.UnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DescriptorProtos.DescriptorProto.Builder toBuilder()
Returns
TypeDescription
DescriptorProtos.DescriptorProto.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Serializes the message and writes it to output. This does not flush or close the stream.

Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException