com.google.api.tools.framework.model

Class ProtoFile

java.lang.Object

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

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

com.google.api.tools.framework.model.ProtoContainerElement

com.google.api.tools.framework.model.ProtoFile

public class ProtoFile
extends ProtoContainerElement

Represents a protocol buffer file.

Method Summary

Modifier and Type	Method and Description
static ProtoFile	create(Model model, com.google.protobuf.DescriptorProtos.FileDescriptorProto proto, boolean isSource, ExtensionPool extensionPool) Creates a new protocol file backed up by the given descriptor.
com.google.common.collect.ImmutableList<ProtoFile>	getDependencies() Returns the dependencies.
java.lang.String	getDocumentation(ProtoElement element) Helper to get the documentation backed up by this proto file for the given element.
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.
com.google.common.collect.ImmutableList<Interface>	getInterfaces() Returns the interfaces in this file.
Location	getLocation() Deliver the location of this protocol element.
Model	getModel() Returns the model.
java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object>	getOptionFields() Return this element's options from the proto.
com.google.protobuf.DescriptorProtos.FileDescriptorProto	getProto() Returns the file descriptor proto.
java.lang.Iterable<Interface>	getReachableInterfaces() Returns the interfaces reachable with active scoper.
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	isSource() Returns true if this file is a proper source, in contrast to a dependency.
java.lang.String	toString()

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

buildChildren, getEnums, getMessages

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

getParent, getSimpleName, 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 ProtoFile create(Model model,
                               com.google.protobuf.DescriptorProtos.FileDescriptorProto proto,
                               boolean isSource,
                               ExtensionPool extensionPool)

Creates a new protocol file backed up by the given descriptor.

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

isSource

public boolean isSource()

Returns true if this file is a proper source, in contrast to a dependency.

getModel

public Model getModel()

Description copied from class: ProtoElement

Returns the model.

Overrides:

getModel in class ProtoElement

getFullName

public java.lang.String getFullName()

Description copied from class: ProtoElement

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.

Overrides:

getFullName in class ProtoElement

getFile

public ProtoFile getFile()

Description copied from class: ProtoElement

Returns the proto file in which this element lives.

Overrides:

getFile in class ProtoElement

getLocation

public Location getLocation()

Description copied from class: ProtoElement

Deliver the location of this protocol element.

Overrides:

getLocation in class ProtoElement

getProto

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

Returns the file descriptor proto.

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

getDependencies

public com.google.common.collect.ImmutableList<ProtoFile> getDependencies()

Returns the dependencies.

getInterfaces

public com.google.common.collect.ImmutableList<Interface> getInterfaces()

Returns the interfaces in this file.

getReachableInterfaces

public java.lang.Iterable<Interface> getReachableInterfaces()

Returns the interfaces reachable with active scoper.

getDocumentation

public java.lang.String getDocumentation(ProtoElement element)

Helper to get the documentation backed up by this proto file for the given element.

getSyntax

public com.google.protobuf.Syntax getSyntax()

Description copied from class: ProtoElement

Gets the syntax in which the element was defined.

Overrides:

getSyntax in class ProtoElement