io.vertx.codegen

Class EnumValueInfo

java.lang.Object

io.vertx.codegen.EnumValueInfo

public class EnumValueInfo
extends Object

The value (member) of an enumeration model.

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
EnumValueInfo(String identifier, Doc doc, boolean deprecated, Text deprecatedDesc)

Method Summary

Modifier and Type	Method and Description
Text	getDeprecatedDesc()
Doc	getDoc()
String	getIdentifier()
boolean	isDeprecated()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumValueInfo

public EnumValueInfo(String identifier,
                     Doc doc,
                     boolean deprecated,
                     Text deprecatedDesc)

Method Detail

getIdentifier

public String getIdentifier()

Returns:

the value identifier

getDoc

public Doc getDoc()

Returns:

the optional documentation

isDeprecated

public boolean isDeprecated()

Returns:

true if the enum value has a @Deprecated annotation

getDeprecatedDesc

public Text getDeprecatedDesc()

Returns:

the description of deprecated