io.vertx.codegen

Class PropertyInfo

java.lang.Object

io.vertx.codegen.PropertyInfo

public class PropertyInfo
extends Object

Describes a property of a data object model.

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
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 Type	Method and Description
String	getAdderMethod()
AnnotationValueInfo	getAnnotation(String annotationName)
List<AnnotationValueInfo>	getAnnotations()
Text	getDeprecatedDesc()
Doc	getDoc()
String	getGetterMethod()
PropertyKind	getKind()
String	getName()
String	getSetterMethod()
TypeInfo	getType()
boolean	isAdder()
boolean	isAnnotated()
boolean	isDeclared()
boolean	isDeprecated()
boolean	isJsonifiable()
boolean	isList()
boolean	isMap()
boolean	isSet()
boolean	isSetter()
boolean	isValue()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyInfo

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

isDeclared

public boolean isDeclared()

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

getDoc

public Doc getDoc()

Returns:

the resolved documentation of this property

getKind

public PropertyKind getKind()

Returns:

the property kind

getName

public String getName()

Returns:

the property name

getType

public TypeInfo getType()

Returns:

the property type

getGetterMethod

public String getGetterMethod()

Returns:

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

getSetterMethod

public String getSetterMethod()

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.

getAdderMethod

public String getAdderMethod()

getAnnotations

public List<AnnotationValueInfo> getAnnotations()

Returns:

the list of AnnotationValueInfo for this property

getAnnotation

public AnnotationValueInfo getAnnotation(String annotationName)

isValue

public boolean isValue()

Returns:

true if the property is managed as a single value

isList

public boolean isList()

Returns:

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

isSet

public boolean isSet()

Returns:

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

isMap

public boolean isMap()

Returns:

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

isSetter

public boolean isSetter()

Returns:

true if the property has a setter method

isAdder

public boolean isAdder()

Returns:

true if the property has an adder method

isAnnotated

public boolean isAnnotated()

Returns:

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

isJsonifiable

public boolean isJsonifiable()

Returns:

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

isDeprecated

public boolean isDeprecated()

Returns:

true if the property has a @Deprecated annotation

getDeprecatedDesc

public Text getDeprecatedDesc()

Returns:

the description of deprecated

toString

public String toString()

Overrides:

toString in class Object