com.google.api.tools.framework.model

Class Field

java.lang.Object

com.google.api.tools.framework.model.Element

com.google.api.tools.framework.model.ProtoElement

com.google.api.tools.framework.model.Field

public class Field
extends ProtoElement

Represents a field declaration.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<Field>	HAS_MESSAGE_TYPE Determines whether field has message type.
static com.google.common.base.Predicate<Field>	IS_CYCLIC Determines whether field is cyclic.
static com.google.common.base.Predicate<Field>	IS_MAP Determines whether field is a map.
static com.google.common.base.Predicate<Field>	IS_ONEOF_SCOPED Determines whether field is part of a oneof.
static com.google.common.base.Predicate<Field>	IS_REPEATED Determines whether field is repeated.
static int	WIRETYPE_END_GROUP
static int	WIRETYPE_FIXED32
static int	WIRETYPE_FIXED64
static int	WIRETYPE_LENGTH_DELIMITED
static int	WIRETYPE_START_GROUP
static int	WIRETYPE_VARINT

Method Summary

Modifier and Type	Method and Description
static Field	create(MessageType parent, com.google.protobuf.DescriptorProtos.FieldDescriptorProto proto, java.lang.String path, Oneof oneof) Creates a field backed up by the given proto.
static Field	createAsExtension(MessageType parent, ExtensionPool.Extension extension, java.lang.String path, java.lang.String name) Creates a field that represents an extension.
java.lang.String	getDefaultValue() Returns the default value of the field, as specified in the descriptor.proto, or null if none is defined.
java.lang.String	getJsonName() Returns the JSON name of the field.
int	getNumber() Returns the field number.
Oneof	getOneof() Returns a oneof associated with this field, or null if none.
com.google.protobuf.DescriptorProtos.FieldDescriptorProto	getProto() Returns the underlying proto representation.
int	getTag() Returns the field tag.
TypeRef	getType() Returns the resolved type
int	getWireType() Returns the wired type encoding for the field.
boolean	isDeprecated() Returns true if this object represents something that is configured as deprecated.
boolean	isOptional() Returns true if the field is optional.
boolean	isPacked() Returns true if the field is packed.
boolean	isRepeated() Returns true if the field is repeated.
boolean	isRequired() Returns true if the field is required (proto2).
boolean	oneofScoped() Returns true if field is oneof-scoped.
void	setOneof(Oneof oneof) For setting the oneof.
void	setType(TypeRef type) For setting the resolved type.
java.lang.String	toString()

Methods inherited from class com.google.api.tools.framework.model.ProtoElement

getFile, getFullName, getLocation, getModel, getParent, getSimpleName, getSyntax, isReachable

Methods inherited from class com.google.api.tools.framework.model.Element

addAttribute, getAttribute, getAttributeOrDefault, hasAttribute, putAttribute, removeAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WIRETYPE_VARINT

public static final int WIRETYPE_VARINT

See Also:

Constant Field Values

WIRETYPE_FIXED64

public static final int WIRETYPE_FIXED64

See Also:

Constant Field Values

WIRETYPE_LENGTH_DELIMITED

public static final int WIRETYPE_LENGTH_DELIMITED

See Also:

Constant Field Values

WIRETYPE_START_GROUP

public static final int WIRETYPE_START_GROUP

See Also:

Constant Field Values

WIRETYPE_END_GROUP

public static final int WIRETYPE_END_GROUP

See Also:

Constant Field Values

WIRETYPE_FIXED32

public static final int WIRETYPE_FIXED32

See Also:

Constant Field Values

HAS_MESSAGE_TYPE

public static final com.google.common.base.Predicate<Field> HAS_MESSAGE_TYPE

Determines whether field has message type.

IS_CYCLIC

public static final com.google.common.base.Predicate<Field> IS_CYCLIC

Determines whether field is cyclic.

IS_REPEATED

public static final com.google.common.base.Predicate<Field> IS_REPEATED

Determines whether field is repeated.

IS_ONEOF_SCOPED

public static final com.google.common.base.Predicate<Field> IS_ONEOF_SCOPED

Determines whether field is part of a oneof.

IS_MAP

public static final com.google.common.base.Predicate<Field> IS_MAP

Determines whether field is a map.

Method Detail

create

public static Field create(MessageType parent,
                           com.google.protobuf.DescriptorProtos.FieldDescriptorProto proto,
                           java.lang.String path,
                           @Nullable
                           Oneof oneof)

Creates a field backed up by the given proto.

createAsExtension

public static Field createAsExtension(MessageType parent,
                                      ExtensionPool.Extension extension,
                                      java.lang.String path,
                                      java.lang.String name)

Creates a field that represents an extension.

getProto

public com.google.protobuf.DescriptorProtos.FieldDescriptorProto getProto()

Returns the underlying proto representation.

oneofScoped

public boolean oneofScoped()

Returns true if field is oneof-scoped.

getOneof

@Nullable
public Oneof getOneof()

Returns a oneof associated with this field, or null if none.

setOneof

public void setOneof(@Nullable
                     Oneof oneof)

For setting the oneof.

isOptional

public boolean isOptional()

Returns true if the field is optional.

isRepeated

public boolean isRepeated()

Returns true if the field is repeated.

isRequired

public boolean isRequired()

Returns true if the field is required (proto2).

isDeprecated

public boolean isDeprecated()

Returns true if this object represents something that is configured as deprecated.

Overrides:

isDeprecated in class ProtoElement

getNumber

public int getNumber()

Returns the field number.

isPacked

public boolean isPacked()

Returns true if the field is packed.

getJsonName

public java.lang.String getJsonName()

Returns the JSON name of the field.

getWireType

public int getWireType()

Returns the wired type encoding for the field.

getTag

public int getTag()

Returns the field tag.

getDefaultValue

@Nullable
public java.lang.String getDefaultValue()

Returns the default value of the field, as specified in the descriptor.proto, or null if none is defined.

getType

public TypeRef getType()

Returns the resolved type

setType

public void setType(TypeRef type)

For setting the resolved type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object