com.google.api.tools.framework.model

Class EnumType

java.lang.Object

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

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

com.google.api.tools.framework.model.EnumType

public class EnumType
extends ProtoElement

Represents an enum declaration.

Method Summary

Modifier and Type	Method and Description
static EnumType	create(ProtoContainerElement parent, com.google.protobuf.DescriptorProtos.EnumDescriptorProto proto, java.lang.String path) Creates an enum backed up by the given proto.
java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object>	getOptionFields() Return this element's options from the proto.
com.google.protobuf.DescriptorProtos.EnumDescriptorProto	getProto() Returns the underlying proto representation.
java.lang.Iterable<EnumValue>	getReachableValues() Returns the enum values for which ProtoElement.isReachable() is true.
com.google.common.collect.ImmutableList<EnumValue>	getValues() Returns the values.
com.google.protobuf.Enum	getVisibleProto() Returns a proto representation that includes visible values only.
boolean	hasHiddenValue() Returns whether any of the enum's values are hidden.
boolean	isDeprecated() Returns true if this object represents something that is configured as deprecated.
EnumValue	lookupValue(java.lang.String name) Looks up the value by its name.
void	setValueByNameMap(com.google.common.collect.ImmutableMap<java.lang.String,EnumValue> valueByName) For setting the value-by-name map.
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

Method Detail

create

public static EnumType create(ProtoContainerElement parent,
                              com.google.protobuf.DescriptorProtos.EnumDescriptorProto proto,
                              java.lang.String path)

Creates an enum backed up by the given proto.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isDeprecated

public boolean isDeprecated()

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

Overrides:

isDeprecated in class ProtoElement

getProto

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

Returns the underlying proto representation.

getOptionFields

public java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object> getOptionFields()

Description copied from class: ProtoElement

Return this element's options from the proto.

Specified by:

getOptionFields in class ProtoElement

getVisibleProto

public com.google.protobuf.Enum getVisibleProto()

Returns a proto representation that includes visible values only. Enum options and source location are omitted since visibility isn't applicable for them.

getValues

public com.google.common.collect.ImmutableList<EnumValue> getValues()

Returns the values.

getReachableValues

public java.lang.Iterable<EnumValue> getReachableValues()

Returns the enum values for which ProtoElement.isReachable() is true.

hasHiddenValue

public boolean hasHiddenValue()

Returns whether any of the enum's values are hidden.

lookupValue

@Nullable
public EnumValue lookupValue(java.lang.String name)

Looks up the value by its name.

setValueByNameMap

public void setValueByNameMap(com.google.common.collect.ImmutableMap<java.lang.String,EnumValue> valueByName)

For setting the value-by-name map.