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 writerMethod, String readerMethod, PropertyKind kind, boolean jsonifiable)

Method Summary

Modifier and Type	Method and Description
Doc	getDoc()
PropertyKind	getKind()
String	getName()
String	getReaderMethod()
TypeInfo	getType()
String	getWriterMethod()
boolean	isAdder()
boolean	isArray()
boolean	isDeclared()
boolean	isJsonifiable()
boolean	isMap()
boolean	isValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyInfo

public PropertyInfo(boolean declared,
                    String name,
                    Doc doc,
                    TypeInfo type,
                    String writerMethod,
                    String readerMethod,
                    PropertyKind kind,
                    boolean jsonifiable)

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

getReaderMethod

public String getReaderMethod()

Returns:

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

getWriterMethod

public String getWriterMethod()

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 isArray() values.

isValue

public boolean isValue()

Returns:

true if the property is managed as a single value

isArray

public boolean isArray()

Returns:

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

isMap

public boolean isMap()

Returns:

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

isAdder

public boolean isAdder()

Returns:

true if the property is using an adder

isJsonifiable

public boolean isJsonifiable()

Returns:

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