Top Description Fields Constructors Methods
io.vertx.codegen

public Class PropertyInfo

extends Object
Class Inheritance
Imports
io.vertx.codegen.doc.Doc, .Text, io.vertx.codegen.type.AnnotationValueInfo, .TypeInfo, java.util.ArrayList, .HashMap, .List, .Map
Describes a property of a data object model.
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
pack-priv final String
adderMethod

pack-priv final Map<String, AnnotationValueInfo>
annotations

pack-priv final boolean
declared

pack-priv final boolean
deprecated

pack-priv final Text
deprecatedDesc

pack-priv final Doc
doc

pack-priv final String
getterMethod

pack-priv final boolean
jsonifiable

pack-priv final PropertyKind
kind

pack-priv final String
name

pack-priv final String
setterMethod

pack-priv final TypeInfo
type

Constructor Summary

AccessConstructor and Description
public
PropertyInfo(boolean declared, String name, Doc doc, TypeInfo type, String setterMethod, String adderMethod, String getterMethod, List<AnnotationValueInfo> annotations, PropertyKind kind, boolean jsonifiable, boolean deprecated, Text deprecatedDesc)

Method Summary

Modifier and TypeMethod and Description
public String
getAdderMethod()

public AnnotationValueInfo
getAnnotation(String annotationName)

public List<AnnotationValueInfo>

Returns:

the list of AnnotationValueInfo for this property
getAnnotations()

public Text

Returns:

the description of deprecated
getDeprecatedDesc()

public Doc

Returns:

the resolved documentation of this property
getDoc()

public String

Returns:

the name of the Java method that can read the state of this property on the data object.
getGetterMethod()

public PropertyKind

Returns:

the property kind
getKind()

public String

Returns:

the property name
getName()

public String

Returns:

the name of the Java method that will update the state of this property on the data object, the nature of the method depends on the isAdder() and isList() values.
getSetterMethod()

public TypeInfo

Returns:

the property type
getType()

public boolean

Returns:

true if the property has an adder method
isAdder()

public boolean

Returns:

true if the property is annotated, either on field or method
isAnnotated()

public boolean

Returns:

true if the property is declared by the its data object, that means it does not override the same property from other data object ancestors
isDeclared()

public boolean

Returns:

true if the property has a @Deprecated annotation
isDeprecated()

public boolean

Returns:

true if the property type can be converted to a Json type
isJsonifiable()

public boolean

Returns:

true if the property is managed by a java.util.List<T>
isList()

public boolean

Returns:

true if the property is managed by a java.util.Map<String, T>
isMap()

public boolean

Returns:

true if the property is managed by a java.util.Set<T>
isSet()

public boolean

Returns:

true if the property has a setter method
isSetter()

public boolean

Returns:

true if the property is managed as a single value
isValue()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

adderMethodback to summary
pack-priv final String adderMethod
annotationsback to summary
pack-priv final Map<String, AnnotationValueInfo> annotations
declaredback to summary
pack-priv final boolean declared
deprecatedback to summary
pack-priv final boolean deprecated
deprecatedDescback to summary
pack-priv final Text deprecatedDesc
docback to summary
pack-priv final Doc doc
getterMethodback to summary
pack-priv final String getterMethod
jsonifiableback to summary
pack-priv final boolean jsonifiable
kindback to summary
pack-priv final PropertyKind kind
nameback to summary
pack-priv final String name
setterMethodback to summary
pack-priv final String setterMethod
typeback to summary
pack-priv final TypeInfo type

Constructor Detail

PropertyInfoback to summary
public PropertyInfo(boolean declared, String name, Doc doc, TypeInfo type, String setterMethod, String adderMethod, String getterMethod, List<AnnotationValueInfo> annotations, PropertyKind kind, boolean jsonifiable, boolean deprecated, Text deprecatedDesc)

Method Detail

getAdderMethodback to summary
public String getAdderMethod()
getAnnotationback to summary
public AnnotationValueInfo getAnnotation(String annotationName)
getAnnotationsback to summary
public List<AnnotationValueInfo> getAnnotations()
Returns:List<AnnotationValueInfo>

the list of AnnotationValueInfo for this property

getDeprecatedDescback to summary
public Text getDeprecatedDesc()
Returns:Text

the description of deprecated

getDocback to summary
public Doc getDoc()
Returns:Doc

the resolved documentation of this property

getGetterMethodback to summary
public String getGetterMethod()
Returns:String

the name of the Java method that can read the state of this property on the data object.

getKindback to summary
public PropertyKind getKind()
Returns:PropertyKind

the property kind

getNameback to summary
public String getName()
Returns:String

the property name

getSetterMethodback to summary
public String getSetterMethod()
Returns:String

the name of the Java method that will update the state of this property on the data object, the nature of the method depends on the isAdder() and isList() values.

getTypeback to summary
public TypeInfo getType()
Returns:TypeInfo

the property type

isAdderback to summary
public boolean isAdder()
Returns:boolean

true if the property has an adder method

isAnnotatedback to summary
public boolean isAnnotated()
Returns:boolean

true if the property is annotated, either on field or method

isDeclaredback to summary
public boolean isDeclared()
Returns:boolean

true if the property is declared by the its data object, that means it does not override the same property from other data object ancestors

isDeprecatedback to summary
public boolean isDeprecated()
Returns:boolean

true if the property has a @Deprecated annotation

isJsonifiableback to summary
public boolean isJsonifiable()
Returns:boolean

true if the property type can be converted to a Json type

isListback to summary
public boolean isList()
Returns:boolean

true if the property is managed by a java.util.List<T>

isMapback to summary
public boolean isMap()
Returns:boolean

true if the property is managed by a java.util.Map<String, T>

isSetback to summary
public boolean isSet()
Returns:boolean

true if the property is managed by a java.util.Set<T>

isSetterback to summary
public boolean isSetter()
Returns:boolean

true if the property has a setter method

isValueback to summary
public boolean isValue()
Returns:boolean

true if the property is managed as a single value

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override