com.google.api.tools.framework.model

Class MessageType

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.MessageType

public class MessageType
extends ProtoContainerElement

Represents a message declaration.

Method Summary

Modifier and Type	Method and Description
static MessageType	create(ProtoContainerElement parent, com.google.protobuf.DescriptorProtos.DescriptorProto proto, java.lang.String path, ExtensionPool extensionPool) Creates a message backed up by the given proto.
java.lang.Iterable<Field>	getCyclicFields() Returns all fields which have cyclic types.
com.google.common.collect.ImmutableList<Field>	getFields() Returns all fields.
java.lang.Iterable<Field>	getMapFields() Returns all fields which are maps.
java.lang.Iterable<Field>	getMessageFields() Returns all fields which have message type.
java.lang.Iterable<Field>	getNonCyclicFields() Returns all fields which have non-cyclic types.
java.lang.Iterable<Field>	getNonMessageFields() Returns all fields which have non-message type.
java.lang.Iterable<Field>	getNonOneofScopedFields() Returns all fields which are not oneof-scoped.
java.lang.Iterable<Field>	getNonRepeatedFields() Returns all fields which are not repeated.
com.google.common.collect.ImmutableList<Oneof>	getOneofs() Returns all oneofs associated with this type.
java.lang.Iterable<Field>	getOneofScopedFields() Returns all fields which are oneof-scoped.
java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object>	getOptionFields() Return this element's options from the proto.
com.google.protobuf.DescriptorProtos.DescriptorProto	getProto() Returns the underlying proto representation.
java.lang.Iterable<Field>	getReachableFields() Returns the fields reachable with the active scoper.
java.lang.Iterable<Field>	getRepeatedFields() Returns all fields which are repeated.
boolean	isCyclic() Returns true if this message or one of its sub-messages refers back to this message.
boolean	isDeprecated() Returns true if this object represents something that is configured as deprecated.
boolean	isExtensible() Returns true if this type can be extended.
boolean	isMapEntry() Returns true if the type is generated for Map entry.
Field	lookupField(java.lang.String name) Looks up the field by its name.
void	setFieldByNameMap(com.google.common.collect.ImmutableMap<java.lang.String,Field> fieldByName) For setting the field-by-name map.
void	setOneofs(com.google.common.collect.ImmutableList<Oneof> oneofs) For setting the oneofs list.
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

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 MessageType create(ProtoContainerElement parent,
                                 com.google.protobuf.DescriptorProtos.DescriptorProto proto,
                                 java.lang.String path,
                                 ExtensionPool extensionPool)

Creates a message 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.DescriptorProto 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

isExtensible

public boolean isExtensible()

Returns true if this type can be extended.

isMapEntry

public boolean isMapEntry()

Returns true if the type is generated for Map entry.

getFields

public com.google.common.collect.ImmutableList<Field> getFields()

Returns all fields.

getReachableFields

public java.lang.Iterable<Field> getReachableFields()

Returns the fields reachable with the active scoper.

getOneofs

public com.google.common.collect.ImmutableList<Oneof> getOneofs()

Returns all oneofs associated with this type.

setOneofs

public void setOneofs(com.google.common.collect.ImmutableList<Oneof> oneofs)

For setting the oneofs list.

lookupField

@Nullable
public Field lookupField(java.lang.String name)

Looks up the field by its name.

setFieldByNameMap

public void setFieldByNameMap(com.google.common.collect.ImmutableMap<java.lang.String,Field> fieldByName)

For setting the field-by-name map.

isCyclic

public boolean isCyclic()

Returns true if this message or one of its sub-messages refers back to this message.

getMessageFields

public java.lang.Iterable<Field> getMessageFields()

Returns all fields which have message type.

getNonMessageFields

public java.lang.Iterable<Field> getNonMessageFields()

Returns all fields which have non-message type.

getCyclicFields

public java.lang.Iterable<Field> getCyclicFields()

Returns all fields which have cyclic types.

getNonCyclicFields

public java.lang.Iterable<Field> getNonCyclicFields()

Returns all fields which have non-cyclic types.

getRepeatedFields

public java.lang.Iterable<Field> getRepeatedFields()

Returns all fields which are repeated.

getNonRepeatedFields

public java.lang.Iterable<Field> getNonRepeatedFields()

Returns all fields which are not repeated.

getOneofScopedFields

public java.lang.Iterable<Field> getOneofScopedFields()

Returns all fields which are oneof-scoped.

getNonOneofScopedFields

public java.lang.Iterable<Field> getNonOneofScopedFields()

Returns all fields which are not oneof-scoped.

getMapFields

public java.lang.Iterable<Field> getMapFields()

Returns all fields which are maps.