Package com.linecorp.armeria.server.docs

Class EnumValueInfo

java.lang.Object

com.linecorp.armeria.server.docs.EnumValueInfo

@UnstableApi
public final class EnumValueInfo
extends Object

Metadata about an enum value.

Constructor Summary

Constructors

Constructor	Description
EnumValueInfo(String name)	Creates a new instance.
EnumValueInfo(String name, @Nullable Integer intValue)	Creates a new instance.
EnumValueInfo(String name, @Nullable Integer intValue, DescriptionInfo descriptionInfo)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
DescriptionInfo	descriptionInfo()	Returns the description information that describes the enum value.
boolean	equals(@Nullable Object o)
int	hashCode()
@Nullable Integer	intValue()	Returns the integer value of the enum value.
String	name()	Returns the name of the enum value.
String	toString()
EnumValueInfo	withDescriptionInfo(DescriptionInfo descriptionInfo)	Returns a new EnumValueInfo with the specified DescriptionInfo.

Methods inherited from class java.lang.Object

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

Constructor Details

EnumValueInfo

public EnumValueInfo(String name)

Creates a new instance.

Parameters:

name - the name of the enum value

EnumValueInfo

public EnumValueInfo(String name,
 @Nullable
 @Nullable Integer intValue)

Creates a new instance.

Parameters:

name - the name of the enum value

intValue - the integer value of the enum value

EnumValueInfo

public EnumValueInfo(String name,
 @Nullable
 @Nullable Integer intValue,
 DescriptionInfo descriptionInfo)

Creates a new instance.

Parameters:

name - the name of the enum value

intValue - the integer value of the enum value

descriptionInfo - the description object that describes the enum value

Method Details

name

public String name()

Returns the name of the enum value.

intValue

@Nullable
public @Nullable Integer intValue()

Returns the integer value of the enum value.

descriptionInfo

public DescriptionInfo descriptionInfo()

Returns the description information that describes the enum value.

withDescriptionInfo

public EnumValueInfo withDescriptionInfo(DescriptionInfo descriptionInfo)

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 @Nullable Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object