Top Description Fields Constructors Methods

io.vertx.codegen

public Class EnumValueInfo

Class Inheritance

extends Object

java.lang.Object
io.vertx.codegen.EnumValueInfo

Imports

io.vertx.codegen.doc.Doc, .Text

The value (member) of an enumeration model.

Author: Julien Viet

Field Summary

Modifier and Type	Field and Description
private final boolean	deprecated
private final Text	deprecatedDesc
private final Doc	doc
private final String	identifier

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public Text	Returns: the description of deprecated getDeprecatedDesc()
public Doc	Returns: the optional documentation getDoc()
public String	Returns: the value identifier getIdentifier()
public boolean	Returns: `true` if the enum value has a `@Deprecated` annotation isDeprecated()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

deprecated	back to summary
private final boolean deprecated

deprecatedDesc	back to summary
private final Text deprecatedDesc

doc	back to summary
private final Doc doc

identifier	back to summary
private final String identifier

Constructor Detail

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

Method Detail

getDeprecatedDesc	back to summary
public Text getDeprecatedDesc() Returns:Text the description of deprecated

getDoc	back to summary
public Doc getDoc() Returns:Doc the optional documentation

getIdentifier	back to summary
public String getIdentifier() Returns:String the value identifier

isDeprecated	back to summary
public boolean isDeprecated() Returns:boolean `true` if the enum value has a `@Deprecated` annotation