TypeRef (api-compiler 0.0.6 API)

java.lang.Object
- com.google.api.tools.framework.model.TypeRef

public class TypeRef
extends java.lang.Object

Represents a reference to a type.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TypeRef.Cardinality` Represents cardinality of a type.
`static class`	`TypeRef.WellKnownType` Represents an enumeration of well-known types.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static TypeRef`	`fromPrimitiveName(java.lang.String name)` Creates a reference to a primitive type based on its name in the protocol buffer language, with default cardinality optional.
`TypeRef.Cardinality`	`getCardinality()` Returns the type cardinality.
`EnumType`	`getEnumType()` If this is a enum type, returns the enum, otherwise fails.
`com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type`	`getKind()` Returns the type kind.
`Location`	`getLocation()` If this is a message or enum type, return its declaration location, otherwise SimpleLocation.UNKNOWN.
`Field`	`getMapKeyField()` Returns the field for the key of a map type.
`Field`	`getMapValueField()` Returns the field for a value of a map type.
`MessageType`	`getMessageType()` If this is a message type, returns the message, otherwise fails.
`java.lang.String`	`getPrimitiveTypeName()` If this is a primitive type, returns the proto type name, otherwise fails.
`TypeRef.WellKnownType`	`getWellKnownType()` Returns the well-known type kind, or NONE if its not one.
`int`	`hashCode()`
`boolean`	`isCyclic()` Return true of this is a cyclic message type.
`boolean`	`isEnum()` Returns true of this is an enum type.
`boolean`	`isMap()` Return trues if this type represents a map.
`boolean`	`isMessage()` Returns true of this is a message type.
`boolean`	`isPrimitive()` Returns true if this is a primitive type.
`boolean`	`isRepeated()` Returns true of the field is repeated.
`TypeRef`	`makeOptional()` Makes the given type to have cardinality optional.
`TypeRef`	`makeRepeated()` Makes the given type to have cardinality repeated.
`TypeRef`	`makeRequired()` Makes the given type to have cardinality required.
`static TypeRef`	`of(com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type primitiveType)` Creates a reference to a primitive type, with default cardinality optional.
`static TypeRef`	`of(EnumType enumType)` Creates a reference to an enum type, with default cardinality optional.
`static TypeRef`	`of(MessageType messageType)` Creates a reference to a message type, with default cardinality optional.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static TypeRef of(com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type primitiveType)
```
    Creates a reference to a primitive type, with default cardinality optional.
  - of
```
public static TypeRef of(MessageType messageType)
```
    Creates a reference to a message type, with default cardinality optional.
  - of
```
public static TypeRef of(EnumType enumType)
```
    Creates a reference to an enum type, with default cardinality optional.
  - fromPrimitiveName
```
@Nullable
public static TypeRef fromPrimitiveName(java.lang.String name)
```
    Creates a reference to a primitive type based on its name in the protocol buffer language, with default cardinality optional.
  - getKind
```
public com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type getKind()
```
    Returns the type kind.
  - getCardinality
```
public TypeRef.Cardinality getCardinality()
```
    Returns the type cardinality.
  - isRepeated
```
public boolean isRepeated()
```
    Returns true of the field is repeated.
  - isMap
```
public boolean isMap()
```
    Return trues if this type represents a map.
  - getMapKeyField
```
public Field getMapKeyField()
```
    Returns the field for the key of a map type. Error if type is not a map.
  - getMapValueField
```
public Field getMapValueField()
```
    Returns the field for a value of a map type. Error if type is not a map.
  - getWellKnownType
```
public TypeRef.WellKnownType getWellKnownType()
```
    Returns the well-known type kind, or NONE if its not one.
  - makeOptional
```
public TypeRef makeOptional()
```
    Makes the given type to have cardinality optional.
  - makeRequired
```
public TypeRef makeRequired()
```
    Makes the given type to have cardinality required.
  - makeRepeated
```
public TypeRef makeRepeated()
```
    Makes the given type to have cardinality repeated.
  - getMessageType
```
public MessageType getMessageType()
```
    If this is a message type, returns the message, otherwise fails.
  - getEnumType
```
public EnumType getEnumType()
```
    If this is a enum type, returns the enum, otherwise fails.
  - getPrimitiveTypeName
```
public java.lang.String getPrimitiveTypeName()
```
    If this is a primitive type, returns the proto type name, otherwise fails.
  - isCyclic
```
public boolean isCyclic()
```
    Return true of this is a cyclic message type.
  - getLocation
```
public Location getLocation()
```
    If this is a message or enum type, return its declaration location, otherwise SimpleLocation.UNKNOWN.
  - isMessage
```
public boolean isMessage()
```
    Returns true of this is a message type.
  - isEnum
```
public boolean isEnum()
```
    Returns true of this is an enum type.
  - isPrimitive
```
public boolean isPrimitive()
```
    Returns true if this is a primitive type.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class TypeRef

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

of

fromPrimitiveName

getKind

getCardinality

isRepeated

isMap

getMapKeyField

getMapValueField

getWellKnownType

makeOptional

makeRequired

makeRepeated

getMessageType

getEnumType

getPrimitiveTypeName

isCyclic

getLocation

isMessage

isEnum

isPrimitive

toString

hashCode

equals