com.google.api.tools.framework.model

Enum TypeRef.WellKnownType

java.lang.Object

java.lang.Enum<TypeRef.WellKnownType>

com.google.api.tools.framework.model.TypeRef.WellKnownType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TypeRef.WellKnownType>

Enclosing class:

TypeRef

public static enum TypeRef.WellKnownType
extends java.lang.Enum<TypeRef.WellKnownType>

Represents an enumeration of well-known types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY
BOOL
BYTES
DOUBLE
DURATION
FIELD_MASK
FLOAT
INT32
INT64
LIST_VALUE
MEDIA
NONE
STRING
STRUCT
TIMESTAMP
UINT32
UINT64
VALUE

Method Summary

Modifier and Type	Method and Description
boolean	allowedAsHttpParameter() Checks whether the WKT can appear in HTTP parameter position.
boolean	allowedAsHttpRequestResponse() Checks whether the WKT can appear as HTTP request/response.
boolean	allowedAsPathParameter() Checks whether the WKT can appear in HTTP template path position.
boolean	allowedAsRequestResponseInCodeGen() Checks whether the WKT is allowed as request/response by codegen.
static TypeRef.WellKnownType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TypeRef.WellKnownType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final TypeRef.WellKnownType NONE

DOUBLE

public static final TypeRef.WellKnownType DOUBLE

FLOAT

public static final TypeRef.WellKnownType FLOAT

INT64

public static final TypeRef.WellKnownType INT64

UINT64

public static final TypeRef.WellKnownType UINT64

INT32

public static final TypeRef.WellKnownType INT32

UINT32

public static final TypeRef.WellKnownType UINT32

BOOL

public static final TypeRef.WellKnownType BOOL

STRING

public static final TypeRef.WellKnownType STRING

BYTES

public static final TypeRef.WellKnownType BYTES

TIMESTAMP

public static final TypeRef.WellKnownType TIMESTAMP

DURATION

public static final TypeRef.WellKnownType DURATION

STRUCT

public static final TypeRef.WellKnownType STRUCT

VALUE

public static final TypeRef.WellKnownType VALUE

LIST_VALUE

public static final TypeRef.WellKnownType LIST_VALUE

ANY

public static final TypeRef.WellKnownType ANY

MEDIA

public static final TypeRef.WellKnownType MEDIA

FIELD_MASK

public static final TypeRef.WellKnownType FIELD_MASK

Method Detail

values

public static TypeRef.WellKnownType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TypeRef.WellKnownType c : TypeRef.WellKnownType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TypeRef.WellKnownType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

allowedAsPathParameter

public boolean allowedAsPathParameter()

Checks whether the WKT can appear in HTTP template path position.

allowedAsHttpParameter

public boolean allowedAsHttpParameter()

Checks whether the WKT can appear in HTTP parameter position.

allowedAsHttpRequestResponse

public boolean allowedAsHttpRequestResponse()

Checks whether the WKT can appear as HTTP request/response.

allowedAsRequestResponseInCodeGen

public boolean allowedAsRequestResponseInCodeGen()

Checks whether the WKT is allowed as request/response by codegen.