public static final class DescriptorProtos.DescriptorProto extends GeneratedMessageV3 implements DescriptorProtos.DescriptorProtoOrBuilder
Describes a message type.
Protobuf type google.protobuf.DescriptorProto
Static Fields
ENUM_TYPE_FIELD_NUMBER
public static final int ENUM_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXTENSION_FIELD_NUMBER
public static final int EXTENSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXTENSION_RANGE_FIELD_NUMBER
public static final int EXTENSION_RANGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FIELD_FIELD_NUMBER
public static final int FIELD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NESTED_TYPE_FIELD_NUMBER
public static final int NESTED_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ONEOF_DECL_FIELD_NUMBER
public static final int ONEOF_DECL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARSER
public static final Parser<DescriptorProtos.DescriptorProto> PARSER
RESERVED_NAME_FIELD_NUMBER
public static final int RESERVED_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESERVED_RANGE_FIELD_NUMBER
public static final int RESERVED_RANGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static DescriptorProtos.DescriptorProto getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DescriptorProtos.DescriptorProto.Builder newBuilder()
newBuilder(DescriptorProtos.DescriptorProto prototype)
public static DescriptorProtos.DescriptorProto.Builder newBuilder(DescriptorProtos.DescriptorProto prototype)
public static DescriptorProtos.DescriptorProto parseDelimitedFrom(InputStream input)
public static DescriptorProtos.DescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DescriptorProtos.DescriptorProto parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.DescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DescriptorProtos.DescriptorProto parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.DescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.DescriptorProto parseFrom(CodedInputStream input)
public static DescriptorProtos.DescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.DescriptorProto parseFrom(InputStream input)
public static DescriptorProtos.DescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DescriptorProtos.DescriptorProto parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.DescriptorProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DescriptorProtos.DescriptorProto> parser()
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 |
|---|
| Name | Description |
obj | Object
|
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.
getEnumType(int index)
public DescriptorProtos.EnumDescriptorProto getEnumType(int index)
repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getEnumTypeCount()
public int getEnumTypeCount()
repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
| Returns |
|---|
| Type | Description |
int | |
getEnumTypeList()
public List<DescriptorProtos.EnumDescriptorProto> getEnumTypeList()
repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
getEnumTypeOrBuilder(int index)
public DescriptorProtos.EnumDescriptorProtoOrBuilder getEnumTypeOrBuilder(int index)
repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getEnumTypeOrBuilderList()
public List<? extends DescriptorProtos.EnumDescriptorProtoOrBuilder> getEnumTypeOrBuilderList()
repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.DescriptorProtos.EnumDescriptorProtoOrBuilder> | |
getExtension(int index)
public DescriptorProtos.FieldDescriptorProto getExtension(int index)
repeated .google.protobuf.FieldDescriptorProto extension = 6;
| Parameter |
|---|
| Name | Description |
index | int
|
getExtensionCount()
public int getExtensionCount()
repeated .google.protobuf.FieldDescriptorProto extension = 6;
| Returns |
|---|
| Type | Description |
int | |
getExtensionList()
public List<DescriptorProtos.FieldDescriptorProto> getExtensionList()
repeated .google.protobuf.FieldDescriptorProto extension = 6;
getExtensionOrBuilder(int index)
public DescriptorProtos.FieldDescriptorProtoOrBuilder getExtensionOrBuilder(int index)
repeated .google.protobuf.FieldDescriptorProto extension = 6;
| Parameter |
|---|
| Name | Description |
index | int
|
getExtensionOrBuilderList()
public List<? extends DescriptorProtos.FieldDescriptorProtoOrBuilder> getExtensionOrBuilderList()
repeated .google.protobuf.FieldDescriptorProto extension = 6;
| Returns |
|---|
| Type | Description |
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 |
|---|
| Name | Description |
index | int
|
getExtensionRangeCount()
public int getExtensionRangeCount()
repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
| Returns |
|---|
| Type | Description |
int | |
getExtensionRangeList()
public List<DescriptorProtos.DescriptorProto.ExtensionRange> getExtensionRangeList()
repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
getExtensionRangeOrBuilder(int index)
public DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder getExtensionRangeOrBuilder(int index)
repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
| Parameter |
|---|
| Name | Description |
index | int
|
getExtensionRangeOrBuilderList()
public List<? extends DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder> getExtensionRangeOrBuilderList()
repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder> | |
getField(int index)
public DescriptorProtos.FieldDescriptorProto getField(int index)
repeated .google.protobuf.FieldDescriptorProto field = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getFieldCount()
public int getFieldCount()
repeated .google.protobuf.FieldDescriptorProto field = 2;
| Returns |
|---|
| Type | Description |
int | |
getFieldList()
public List<DescriptorProtos.FieldDescriptorProto> getFieldList()
repeated .google.protobuf.FieldDescriptorProto field = 2;
getFieldOrBuilder(int index)
public DescriptorProtos.FieldDescriptorProtoOrBuilder getFieldOrBuilder(int index)
repeated .google.protobuf.FieldDescriptorProto field = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getFieldOrBuilderList()
public List<? extends DescriptorProtos.FieldDescriptorProtoOrBuilder> getFieldOrBuilderList()
repeated .google.protobuf.FieldDescriptorProto field = 2;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.DescriptorProtos.FieldDescriptorProtoOrBuilder> | |
getName()
optional string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
optional string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getNestedType(int index)
public DescriptorProtos.DescriptorProto getNestedType(int index)
repeated .google.protobuf.DescriptorProto nested_type = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getNestedTypeCount()
public int getNestedTypeCount()
repeated .google.protobuf.DescriptorProto nested_type = 3;
| Returns |
|---|
| Type | Description |
int | |
getNestedTypeList()
public List<DescriptorProtos.DescriptorProto> getNestedTypeList()
repeated .google.protobuf.DescriptorProto nested_type = 3;
getNestedTypeOrBuilder(int index)
public DescriptorProtos.DescriptorProtoOrBuilder getNestedTypeOrBuilder(int index)
repeated .google.protobuf.DescriptorProto nested_type = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getNestedTypeOrBuilderList()
public List<? extends DescriptorProtos.DescriptorProtoOrBuilder> getNestedTypeOrBuilderList()
repeated .google.protobuf.DescriptorProto nested_type = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.DescriptorProtos.DescriptorProtoOrBuilder> | |
getOneofDecl(int index)
public DescriptorProtos.OneofDescriptorProto getOneofDecl(int index)
repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
| Parameter |
|---|
| Name | Description |
index | int
|
getOneofDeclCount()
public int getOneofDeclCount()
repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
| Returns |
|---|
| Type | Description |
int | |
getOneofDeclList()
public List<DescriptorProtos.OneofDescriptorProto> getOneofDeclList()
repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
getOneofDeclOrBuilder(int index)
public DescriptorProtos.OneofDescriptorProtoOrBuilder getOneofDeclOrBuilder(int index)
repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
| Parameter |
|---|
| Name | Description |
index | int
|
getOneofDeclOrBuilderList()
public List<? extends DescriptorProtos.OneofDescriptorProtoOrBuilder> getOneofDeclOrBuilderList()
repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.DescriptorProtos.OneofDescriptorProtoOrBuilder> | |
getOptions()
public DescriptorProtos.MessageOptions getOptions()
optional .google.protobuf.MessageOptions options = 7;
getOptionsOrBuilder()
public DescriptorProtos.MessageOptionsOrBuilder getOptionsOrBuilder()
optional .google.protobuf.MessageOptions options = 7;
getParserForType()
public Parser<DescriptorProtos.DescriptorProto> getParserForType()
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 |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
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 |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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;
getReservedRange(int index)
public DescriptorProtos.DescriptorProto.ReservedRange getReservedRange(int index)
repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
getReservedRangeCount()
public int getReservedRangeCount()
repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
| Returns |
|---|
| Type | Description |
int | |
getReservedRangeList()
public List<DescriptorProtos.DescriptorProto.ReservedRange> getReservedRangeList()
repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
getReservedRangeOrBuilder(int index)
public DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder getReservedRangeOrBuilder(int index)
repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
getReservedRangeOrBuilderList()
public List<? extends DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder> getReservedRangeOrBuilderList()
repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasName()
optional string name = 1;
| Returns |
|---|
| Type | Description |
boolean | Whether the name field is set.
|
hasOptions()
public boolean hasOptions()
optional .google.protobuf.MessageOptions options = 7;
| Returns |
|---|
| Type | Description |
boolean | Whether the options field is set.
|
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 |
|---|
| Type | Description |
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.
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DescriptorProtos.DescriptorProto.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DescriptorProtos.DescriptorProto.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Creates a new instance of this message type. Overridden in the generated code.
toBuilder()
public DescriptorProtos.DescriptorProto.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Serializes the message and writes it to output. This does not flush or close the
stream.
