Package com.linecorp.armeria.server.docs

Class EnumInfo

java.lang.Object

com.linecorp.armeria.server.docs.EnumInfo

All Implemented Interfaces:

NamedTypeInfo

@UnstableApi
public final class EnumInfo
extends Object
implements NamedTypeInfo

Metadata about an enum type.

Constructor Summary

Constructors

Constructor	Description
EnumInfo(Class<? extends Enum<?>> enumType)	Creates a new instance.
EnumInfo(Class<? extends Enum<?>> enumType, String docString)	Creates a new instance.
EnumInfo(String name, Class<? extends Enum<?>> enumType)	Creates a new instance.
EnumInfo(String name, Class<? extends Enum<?>> enumType, String docString)	Creates a new instance.
EnumInfo(String name, Iterable<EnumValueInfo> values)	Creates a new instance.
EnumInfo(String name, Iterable<EnumValueInfo> values, String docString)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	docString()	Returns the documentation string.
boolean	equals(Object o)
int	hashCode()
String	name()	Returns the fully qualified type name.
String	toString()
List<EnumValueInfo>	values()	Returns the constant values defined by the type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.server.docs.NamedTypeInfo

findNamedTypes

Constructor Details

EnumInfo

public EnumInfo(Class<? extends Enum<?>> enumType)

Creates a new instance.

EnumInfo

public EnumInfo(Class<? extends Enum<?>> enumType,
String docString)

Creates a new instance.

EnumInfo

public EnumInfo(String name,
Class<? extends Enum<?>> enumType)

Creates a new instance.

EnumInfo

public EnumInfo(String name,
Class<? extends Enum<?>> enumType,
@Nullable
String docString)

Creates a new instance.

EnumInfo

public EnumInfo(String name,
Iterable<EnumValueInfo> values)

Creates a new instance.

EnumInfo

public EnumInfo(String name,
Iterable<EnumValueInfo> values,
@Nullable
String docString)

Creates a new instance.

Method Details

name

public String name()

Description copied from interface: NamedTypeInfo

Returns the fully qualified type name.

Specified by:

name in interface NamedTypeInfo

values

public List<EnumValueInfo> values()

Returns the constant values defined by the type.

docString

public String docString()

Description copied from interface: NamedTypeInfo

Returns the documentation string. If not available, an empty string is returned.

Specified by:

docString in interface NamedTypeInfo

equals

public boolean equals(@Nullable
Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object