com.google.api.tools.framework.model

Class Interface

java.lang.Object

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

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

com.google.api.tools.framework.model.Interface

public class Interface
extends ProtoElement

Represents a interface declarations

Method Summary

Modifier and Type	Method and Description
static Interface	create(ProtoFile parent, com.google.protobuf.DescriptorProtos.ServiceDescriptorProto proto, java.lang.String path) Creates a interface backed up by the given proto.
com.google.protobuf.Api	getConfig() Returns the api config.
com.google.common.collect.ImmutableList<Method>	getMethods() Returns the methods.
java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object>	getOptionFields() Return this element's options from the proto.
com.google.protobuf.DescriptorProtos.ServiceDescriptorProto	getProto() Returns the underlying proto representation.
java.lang.Iterable<Method>	getReachableMethods() Returns the methods reachable with the active scoper.
boolean	isDeprecated() Returns true if this object represents something that is configured as deprecated.
Method	lookupMethod(java.lang.String name) Looks up a method by its name.
void	setConfig(com.google.protobuf.Api config) Sets the api config.
void	setMethodByNameMap(com.google.common.collect.ImmutableMap<java.lang.String,Method> methodByName) For setting the method-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 Interface create(ProtoFile parent,
                               com.google.protobuf.DescriptorProtos.ServiceDescriptorProto proto,
                               java.lang.String path)

Creates a interface 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.ServiceDescriptorProto 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

getMethods

public com.google.common.collect.ImmutableList<Method> getMethods()

Returns the methods.

getReachableMethods

public java.lang.Iterable<Method> getReachableMethods()

Returns the methods reachable with the active scoper.

lookupMethod

@Nullable
public Method lookupMethod(java.lang.String name)

Looks up a method by its name.

setMethodByNameMap

public void setMethodByNameMap(com.google.common.collect.ImmutableMap<java.lang.String,Method> methodByName)

For setting the method-by-name map.

getConfig

public com.google.protobuf.Api getConfig()

Returns the api config.

setConfig

public void setConfig(com.google.protobuf.Api config)

Sets the api config.