Package com.linecorp.armeria.server.docs

Enum Class TypeSignatureType

java.lang.Object

java.lang.Enum<TypeSignatureType>

com.linecorp.armeria.server.docs.TypeSignatureType

All Implemented Interfaces:

Serializable, Comparable<TypeSignatureType>, Constable

@UnstableApi
public enum TypeSignatureType
extends Enum<TypeSignatureType>

Represents the different type that is used for DocService.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE	Base type.
CONTAINER	Container type.
ENUM	Enum type.
ITERABLE	Iterable type.
MAP	Map type.
OPTIONAL	Optional type.
STRUCT	Struct of exception type.
UNRESOLVED	Unresolved type.

Method Summary

Modifier and Type	Method	Description
boolean	hasParameter()	Returns true if the type has type parameter TypeSignature.
boolean	hasTypeDescriptor()	Returns true if this TypeSignatureType has type a type descriptor.
static TypeSignatureType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TypeSignatureType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BASE

public static final TypeSignatureType BASE

Base type.

STRUCT

public static final TypeSignatureType STRUCT

Struct of exception type. The TypeSignature whose type is STRUCT is converted to a StructInfo or ExceptionInfo

ENUM

public static final TypeSignatureType ENUM

Enum type. The TypeSignature whose type is ENUM is converted to a EnumInfo.

ITERABLE

public static final TypeSignatureType ITERABLE

Iterable type.

MAP

public static final TypeSignatureType MAP

Map type.

OPTIONAL

public static final TypeSignatureType OPTIONAL

Optional type.

CONTAINER

public static final TypeSignatureType CONTAINER

Container type.

UNRESOLVED

public static final TypeSignatureType UNRESOLVED

Unresolved type.

Method Details

values

public static TypeSignatureType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TypeSignatureType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

hasParameter

public boolean hasParameter()

Returns true if the type has type parameter TypeSignature.

hasTypeDescriptor

public boolean hasTypeDescriptor()

Returns true if this TypeSignatureType has type a type descriptor.