org.jboss.forge.addon.parser.java.beans

Class Property

java.lang.Object

org.jboss.forge.addon.parser.java.beans.Property

public class Property
extends Object

Represents a single instance of a property corresponding to a field and/or a JavaBean style accessor and mutator.

Constructor Summary

Constructors

Constructor and Description
Property(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.jboss.forge.parser.java.Method<org.jboss.forge.parser.java.JavaClass>	getAccessor() Returns a reference to the accessor Method instance for this property.
org.jboss.forge.parser.java.Field<org.jboss.forge.parser.java.JavaClass>	getActualField() Returns a reference to the Field instance represented by the property.
org.jboss.forge.parser.java.Method<org.jboss.forge.parser.java.JavaClass>	getMutator() Returns a reference to the mutator Method instance for this property.
String	getName() The name of the property as governed by the JavaBeans property naming convention.
String	getQualifiedType() Retrieves the qualified name of the Type corresponding to the property.
String	getSimpleType() Retrieves the simple name of the Type corresponding to the property.
org.jboss.forge.parser.java.Type<?>	getType() Retrieves the Type of the property.
boolean	hasAnnotation(Class<? extends Annotation> klass) Verifies whether the provided annotation is present on the property.
boolean	hasAnnotation(Class<? extends Annotation> klass, ElementType type) Verifies whether the provided annotation is present on the property at the level of the field or the accessor.
int	hashCode()
boolean	isPrimitive() Indicates whether the underlying field or the accessor returns a Java language primitive type.
boolean	isReadable() Indicates whether a property can be read from via a getter, or not.
boolean	isReadOnly() Indicates whether a property is read only or not.
boolean	isTransient() Indicates whether the property is transient or not.
boolean	isWritable() Indicates whether a property can be writter to via a setter, or not.
boolean	isWriteOnly() Indicates whether a property is write only or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(String name)

Method Detail

getName

public String getName()

The name of the property as governed by the JavaBeans property naming convention. This automatically happens to be field name. If a property has a getter named getX() then the property name is 'X' (without quotes). Boolean property getters starting with 'is' are also considered - isX() corresponds to a property named 'X'.

Returns:

The name of the property.

getActualField

public org.jboss.forge.parser.java.Field<org.jboss.forge.parser.java.JavaClass> getActualField()

Returns a reference to the Field instance represented by the property.

Returns:

The backing field for this property

getAccessor

public org.jboss.forge.parser.java.Method<org.jboss.forge.parser.java.JavaClass> getAccessor()

Returns a reference to the accessor Method instance for this property.

Returns:

The accessor method for this property

getMutator

public org.jboss.forge.parser.java.Method<org.jboss.forge.parser.java.JavaClass> getMutator()

Returns a reference to the mutator Method instance for this property.

Returns:

The mutator method for this property

isReadable

public boolean isReadable()

Indicates whether a property can be read from via a getter, or not.

Returns:

true if the property has a getter, false otherwise

isWritable

public boolean isWritable()

Indicates whether a property can be writter to via a setter, or not.

Returns:

true if the property has a setter, false otherwise

isReadOnly

public boolean isReadOnly()

Indicates whether a property is read only or not.

Returns:

true if the property has an accessor only, false otherwise. If no accessor is found, it will return false.

isWriteOnly

public boolean isWriteOnly()

Indicates whether a property is write only or not.

Returns:

true if the property has a mutator only, false otherwise. If no mutator is found, it will return false.

hasAnnotation

public boolean hasAnnotation(Class<? extends Annotation> klass)

Verifies whether the provided annotation is present on the property. Only fields and accessors are considered. Mutators/setter methods are ignored.

Parameters:

klass - The annotation class whose presence is to be verified

Returns:

true if the annotation is present on the field or the accessor of the property

hasAnnotation

public boolean hasAnnotation(Class<? extends Annotation> klass,
                    ElementType type)

Verifies whether the provided annotation is present on the property at the level of the field or the accessor. Only fields and accessors are considered. Mutators/setters are not considered valid arguments.

Parameters:

klass - The annotation class whose presence is to be verified

type - The ElementType at which the annotation should be specified. Should be either ElementType.FIELD or ElementType.METHOD.

Returns:

true if the annotation was found on the specified element of the property

isTransient

public boolean isTransient()

Indicates whether the property is transient or not.

Returns:

true if the underlying field of the property is transient

getType

public org.jboss.forge.parser.java.Type<?> getType()

Retrieves the Type of the property.

Returns:

the Type of the property

getSimpleType

public String getSimpleType()

Retrieves the simple name of the Type corresponding to the property.

Returns:

the simple name of the property's Type.

getQualifiedType

public String getQualifiedType()

Retrieves the qualified name of the Type corresponding to the property.

Returns:

the qualified name of the property's Type.

isPrimitive

public boolean isPrimitive()

Indicates whether the underlying field or the accessor returns a Java language primitive type.

Returns:

true if the type of the property is a Java language primitive.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object