com.google.api.tools.framework.model

Class ProtoElement

java.lang.Object

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

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

Direct Known Subclasses:

EnumType, EnumValue, Field, Interface, Method, Oneof, ProtoContainerElement

public abstract class ProtoElement
extends Element

Base class of model elements which stem from protocol buffers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtoElement(ProtoElement parent, java.lang.String name, java.lang.String path) Creates the element, given its parent and (simple) name.

Method Summary

Modifier and Type	Method and Description
ProtoFile	getFile() Returns the proto file in which this element lives.
java.lang.String	getFullName() Returns the full name of this element, including package and outer messages for nested elements.
Location	getLocation() Deliver the location of this protocol element.
Model	getModel() Returns the model.
abstract java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object>	getOptionFields() Return this element's options from the proto.
ProtoElement	getParent() Returns the parent, or null if this a root (a proto file).
java.lang.String	getSimpleName() Returns the simple name.
com.google.protobuf.Syntax	getSyntax() Gets the syntax in which the element was defined.
boolean	isDeprecated() Returns true if this object represents something that is configured as deprecated.
boolean	isReachable() Return true if the element is reachable with the current scoper.

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, toString, wait, wait, wait

Constructor Detail

ProtoElement

protected ProtoElement(@Nullable
                       ProtoElement parent,
                       java.lang.String name,
                       java.lang.String path)

Creates the element, given its parent and (simple) name.

Method Detail

getParent

@Nullable
public ProtoElement getParent()

Returns the parent, or null if this a root (a proto file).

getModel

public Model getModel()

Returns the model.

Specified by:

getModel in class Element

getSimpleName

public java.lang.String getSimpleName()

Returns the simple name. For a file, this will return the file name, relative to root of source tree.

Specified by:

getSimpleName in class Element

getFullName

public java.lang.String getFullName()

Returns the full name of this element, including package and outer messages for nested elements. For a file, this will return the package name of the file.

Specified by:

getFullName in class Element

getFile

public ProtoFile getFile()

Returns the proto file in which this element lives.

getOptionFields

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

Return this element's options from the proto.

getLocation

public Location getLocation()

Deliver the location of this protocol element.

Specified by:

getLocation in class Element

getSyntax

public com.google.protobuf.Syntax getSyntax()

Gets the syntax in which the element was defined.

isReachable

public boolean isReachable()

Return true if the element is reachable with the current scoper.

isDeprecated

public boolean isDeprecated()

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