Package com.linecorp.armeria.server.docs

Class EnumInfo

java.lang.Object

com.linecorp.armeria.server.docs.EnumInfo

All Implemented Interfaces:

DescriptiveTypeInfo

@UnstableApi
public final class EnumInfo
extends Object
implements DescriptiveTypeInfo

Metadata about an enum type.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DescriptionInfo	descriptionInfo()	Returns the description information of the enum.
boolean	equals(@Nullable 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.
EnumInfo	withDescriptionInfo(DescriptionInfo descriptionInfo)	Returns a new EnumInfo with the specified DescriptionInfo.
EnumInfo	withValues(Iterable<EnumValueInfo> values)	Returns a new EnumInfo with the specified DescriptionInfo.

Methods inherited from class java.lang.Object

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

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

findDescriptiveTypes

Constructor Details

EnumInfo

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

Creates a new instance.

EnumInfo

public EnumInfo(Class<? extends Enum<?>> enumType,
 DescriptionInfo descriptionInfo)

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,
 DescriptionInfo descriptionInfo)

Creates a new instance.

EnumInfo

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

Creates a new instance.

EnumInfo

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

Creates a new instance.

Method Details

name

public String name()

Description copied from interface: DescriptiveTypeInfo

Returns the fully qualified type name.

Specified by:

name in interface DescriptiveTypeInfo

values

public List<EnumValueInfo> values()

Returns the constant values defined by the type.

withValues

public EnumInfo withValues(Iterable<EnumValueInfo> values)

Returns a new EnumInfo with the specified DescriptionInfo. Returns this if this EnumInfo has the same DescriptionInfo.

descriptionInfo

public DescriptionInfo descriptionInfo()

Returns the description information of the enum.

Specified by:

descriptionInfo in interface DescriptiveTypeInfo

withDescriptionInfo

public EnumInfo withDescriptionInfo(DescriptionInfo descriptionInfo)

Returns a new EnumInfo with the specified DescriptionInfo. Returns this if this EnumInfo has the same DescriptionInfo.

equals

public boolean equals(@Nullable
 @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