com.google.protobuf

Class Field

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.Field

All Implemented Interfaces:

FieldOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Field
extends GeneratedMessage
implements FieldOrBuilder

Protobuf type google.protobuf.Field

 Field represents a single field of a message type.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Builder Protobuf type google.protobuf.Field
static class	Field.Cardinality Protobuf enum google.protobuf.Field.Cardinality
static class	Field.Kind Protobuf enum google.protobuf.Field.Kind

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

Fields

Modifier and Type	Field and Description
static int	CARDINALITY_FIELD_NUMBER
static int	KIND_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	NUMBER_FIELD_NUMBER
static int	ONEOF_INDEX_FIELD_NUMBER
static int	OPTIONS_FIELD_NUMBER
static int	PACKED_FIELD_NUMBER
static Parser<Field>	PARSER
static int	TYPE_URL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Methods

Modifier and Type	Method and Description
Field.Cardinality	getCardinality() optional .google.protobuf.Field.Cardinality cardinality = 2;
int	getCardinalityValue() optional .google.protobuf.Field.Cardinality cardinality = 2;
static Field	getDefaultInstance()
Field	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Field.Kind	getKind() optional .google.protobuf.Field.Kind kind = 1;
int	getKindValue() optional .google.protobuf.Field.Kind kind = 1;
String	getName() optional string name = 4;
ByteString	getNameBytes() optional string name = 4;
int	getNumber() optional int32 number = 3;
int	getOneofIndex() optional int32 oneof_index = 7;
Option	getOptions(int index) repeated .google.protobuf.Option options = 9;
int	getOptionsCount() repeated .google.protobuf.Option options = 9;
List<Option>	getOptionsList() repeated .google.protobuf.Option options = 9;
OptionOrBuilder	getOptionsOrBuilder(int index) repeated .google.protobuf.Option options = 9;
List<? extends OptionOrBuilder>	getOptionsOrBuilderList() repeated .google.protobuf.Option options = 9;
boolean	getPacked() optional bool packed = 8;
Parser<Field>	getParserForType() Gets the parser for a message of the same type as this message.
int	getSerializedSize() Get the number of bytes required to encode this message.
String	getTypeUrl() optional string type_url = 6;
ByteString	getTypeUrlBytes() optional string type_url = 6;
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable() Get the FieldAccessorTable for this type.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static Field.Builder	newBuilder()
static Field.Builder	newBuilder(Field prototype)
Field.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
protected Field.Builder	newBuilderForType(GeneratedMessage.BuilderParent parent)
static Field	parseDelimitedFrom(InputStream input)
static Field	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(byte[] data)
static Field	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(ByteString data)
static Field	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(CodedInputStream input)
static Field	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(InputStream input)
static Field	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Field.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField, writeReplace

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

See Also:

Constant Field Values

CARDINALITY_FIELD_NUMBER

public static final int CARDINALITY_FIELD_NUMBER

See Also:

Constant Field Values

NUMBER_FIELD_NUMBER

public static final int NUMBER_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_URL_FIELD_NUMBER

public static final int TYPE_URL_FIELD_NUMBER

See Also:

Constant Field Values

ONEOF_INDEX_FIELD_NUMBER

public static final int ONEOF_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

PACKED_FIELD_NUMBER

public static final int PACKED_FIELD_NUMBER

See Also:

Constant Field Values

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

public static final Parser<Field> PARSER

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable 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 class GeneratedMessage

getKindValue

public int getKindValue()

optional .google.protobuf.Field.Kind kind = 1;

 The field kind.
 

Specified by:

getKindValue in interface FieldOrBuilder

getKind

public Field.Kind getKind()

optional .google.protobuf.Field.Kind kind = 1;

 The field kind.
 

Specified by:

getKind in interface FieldOrBuilder

getCardinalityValue

public int getCardinalityValue()

optional .google.protobuf.Field.Cardinality cardinality = 2;

 The field cardinality, i.e. optional/required/repeated.
 

Specified by:

getCardinalityValue in interface FieldOrBuilder

getCardinality

public Field.Cardinality getCardinality()

optional .google.protobuf.Field.Cardinality cardinality = 2;

 The field cardinality, i.e. optional/required/repeated.
 

Specified by:

getCardinality in interface FieldOrBuilder

getNumber

public int getNumber()

optional int32 number = 3;

 The proto field number.
 

Specified by:

getNumber in interface FieldOrBuilder

getName

public String getName()

optional string name = 4;

 The field name.
 

Specified by:

getName in interface FieldOrBuilder

getNameBytes

public ByteString getNameBytes()

optional string name = 4;

 The field name.
 

Specified by:

getNameBytes in interface FieldOrBuilder

getTypeUrl

public String getTypeUrl()

optional string type_url = 6;

 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 

Specified by:

getTypeUrl in interface FieldOrBuilder

getTypeUrlBytes

public ByteString getTypeUrlBytes()

optional string type_url = 6;

 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 

Specified by:

getTypeUrlBytes in interface FieldOrBuilder

getOneofIndex

public int getOneofIndex()

optional int32 oneof_index = 7;

 Index in Type.oneofs. Starts at 1. Zero means no oneof mapping.
 

Specified by:

getOneofIndex in interface FieldOrBuilder

getPacked

public boolean getPacked()

optional bool packed = 8;

 Whether to use alternative packed wire representation.
 

Specified by:

getPacked in interface FieldOrBuilder

getOptionsList

public List<Option> getOptionsList()

repeated .google.protobuf.Option options = 9;

 The proto options.
 

Specified by:

getOptionsList in interface FieldOrBuilder

getOptionsOrBuilderList

public List<? extends OptionOrBuilder> getOptionsOrBuilderList()

repeated .google.protobuf.Option options = 9;

 The proto options.
 

Specified by:

getOptionsOrBuilderList in interface FieldOrBuilder

getOptionsCount

public int getOptionsCount()

repeated .google.protobuf.Option options = 9;

 The proto options.
 

Specified by:

getOptionsCount in interface FieldOrBuilder

getOptions

public Option getOptions(int index)

repeated .google.protobuf.Option options = 9;

 The proto options.
 

Specified by:

getOptions in interface FieldOrBuilder

getOptionsOrBuilder

public OptionOrBuilder getOptionsOrBuilder(int index)

repeated .google.protobuf.Option options = 9;

 The proto options.
 

Specified by:

getOptionsOrBuilder in interface FieldOrBuilder

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.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

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

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

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 interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

parseFrom

public static Field parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(ByteString data,
              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data,
              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(InputStream input,
              ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(InputStream input,
                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(CodedInputStream input,
              ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Field.Builder newBuilderForType()

Description copied from interface: MessageLite

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

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Field.Builder newBuilder()

newBuilder

public static Field.Builder newBuilder(Field prototype)

toBuilder

public Field.Builder 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 interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Field.Builder newBuilderForType(GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessage

getDefaultInstance

public static Field getDefaultInstance()

getParserForType

public Parser<Field> getParserForType()

Description copied from interface: MessageLite

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

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public Field 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.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder