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, Integer intValue)	Creates a new instance.
EnumValueInfo(String name, Integer intValue, String docString)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	docString()	Returns the documentation string that describes the enum value.
boolean	equals(Object o)
int	hashCode()
Integer	intValue()	Returns the integer value of the enum value.
String	name()	Returns the name of the enum value.
String	toString()

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
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
Integer intValue,
@Nullable
String docString)

Creates a new instance.

Parameters:

name - the name of the enum value

intValue - the integer value of the enum value

docString - the documentation string that describes the enum value

Method Details

name

public String name()

Returns the name of the enum value.

intValue

@Nullable
public Integer intValue()

Returns the integer value of the enum value.

docString

@Nullable
public String docString()

Returns the documentation string that describes the enum value.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object