Package org.jboss.forge.roaster.model.source

Interface PropertySource<O extends JavaSource<O>>

Type Parameters:

O -

All Superinterfaces:

AnnotationTarget<O>, Internal, Named, NamedSource<PropertySource<O>>, Origin<O>, Property<O>

public interface PropertySource<O extends JavaSource<O>>
extends Property<O>, NamedSource<PropertySource<O>>

Source variant of Property interface.

Author:

mbenson

Method Summary

Modifier and Type	Method	Description
MethodSource<O>	createAccessor()	Create the accessor method.
FieldSource<O>	createField()	Create the storing field.
MethodSource<O>	createMutator()	Create the mutator method.
MethodSource<O>	getAccessor()	Override.
FieldSource<O>	getField()	Override.
MethodSource<O>	getMutator()	Override.
PropertySource<O>	removeAccessor()	Remove the accessor method.
PropertySource<O>	removeField()	Remove the storing field.
PropertySource<O>	removeMutator()	Remove the mutator method.
PropertySource<O>	setAccessible(boolean accessible)	Set whether this property is accessible.
PropertySource<O>	setMutable(boolean mutable)	Set whether this property is mutable.
PropertySource<O>	setType(java.lang.Class<?> clazz)	Set the type of this Property to the given Class type.
PropertySource<O>	setType(java.lang.String type)	Set the type of this Property to the given type.
PropertySource<O>	setType(JavaType<?> entity)	Set the type of this Property to the given JavaType type.

Methods inherited from interface org.jboss.forge.roaster.model.AnnotationTarget

getAnnotation, getAnnotation, getAnnotations, hasAnnotation, hasAnnotation

Methods inherited from interface org.jboss.forge.roaster.Internal

getInternal

Methods inherited from interface org.jboss.forge.roaster.model.Named

getName

Methods inherited from interface org.jboss.forge.roaster.model.source.NamedSource

setName

Methods inherited from interface org.jboss.forge.roaster.Origin

getOrigin

Methods inherited from interface org.jboss.forge.roaster.model.Property

getType, hasField, isAccessible, isMutable

Method Detail

setType

PropertySource<O> setType(java.lang.Class<?> clazz)

Set the type of this Property to the given Class type. Attempt to add an import statement to this Property's base PropertySource if required. It is the caller's responsibility to create new equals(Object) and hashCode() methods, e.g. by using Refactory.createHashCodeAndEquals(JavaClassSource, FieldSource[])

setType

PropertySource<O> setType(java.lang.String type)

Set the type of this Property to the given type. Attempt to add an import statement to this Property's base PropertySource if required. (Note that the given className must be fully-qualified in order to properly import required classes) It is the caller's responsibility to create new equals(Object) and hashCode() methods, e.g. by using Refactory.createHashCodeAndEquals(JavaClassSource, FieldSource[])

setType

PropertySource<O> setType(JavaType<?> entity)

Set the type of this Property to the given JavaType type. Attempt to add an import statement to this field's base PropertySource if required. It is the caller's responsibility to create new equals(Object) and hashCode() methods, e.g. by using Refactory.createHashCodeAndEquals(JavaClassSource, FieldSource[])

createAccessor

MethodSource<O> createAccessor()

Create the accessor method.

Throws:

java.lang.IllegalStateException - if property name unset or method already exists

getAccessor

MethodSource<O> getAccessor()

Override.

Specified by:

getAccessor in interface Property<O extends JavaSource<O>>

removeAccessor

PropertySource<O> removeAccessor()

Remove the accessor method.

createMutator

MethodSource<O> createMutator()

Create the mutator method.

Throws:

java.lang.IllegalStateException - if property name unset or method already exists

getMutator

MethodSource<O> getMutator()

Override.

Specified by:

getMutator in interface Property<O extends JavaSource<O>>

removeMutator

PropertySource<O> removeMutator()

Remove the mutator method.

setAccessible

PropertySource<O> setAccessible(boolean accessible)

Set whether this property is accessible.

setMutable

PropertySource<O> setMutable(boolean mutable)

Set whether this property is mutable.

createField

FieldSource<O> createField()

Create the storing field.

Throws:

java.lang.IllegalStateException - if property name unset or method already exists

getField

FieldSource<O> getField()

Override.

Specified by:

getField in interface Property<O extends JavaSource<O>>

removeField

PropertySource<O> removeField()

Remove the storing field.