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

Class FieldOperations

java.lang.Object

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

public class FieldOperations
extends Object

Operations for manipulating JavaBeans methods of a class

Author:

George Gastaldi

Constructor Summary

Constructors

Constructor and Description
FieldOperations()

Method Summary

Modifier and Type	Method and Description
org.jboss.forge.roaster.model.source.FieldSource<org.jboss.forge.roaster.model.source.JavaClassSource>	addFieldTo(org.jboss.forge.roaster.model.source.JavaClassSource targetClass, String fieldType, String fieldName, String... annotations) Adds the field with private visibility, including getter and setter, updating the toString()
org.jboss.forge.roaster.model.source.FieldSource<org.jboss.forge.roaster.model.source.JavaClassSource>	addFieldTo(org.jboss.forge.roaster.model.source.JavaClassSource targetClass, String fieldType, String fieldName, org.jboss.forge.roaster.model.Visibility visibility, boolean withGetter, boolean withSetter, boolean updateToString, String... annotations) Adds the field, updating the toString().
org.jboss.forge.roaster.model.source.FieldSource<org.jboss.forge.roaster.model.source.JavaClassSource>	addFieldTo(org.jboss.forge.roaster.model.source.JavaClassSource targetClass, String fieldType, String fieldName, org.jboss.forge.roaster.model.Visibility visibility, boolean withGetter, boolean withSetter, String... annotations) Adds the field, updating the toString().
protected boolean	canAddFieldToToString(org.jboss.forge.roaster.model.Field<org.jboss.forge.roaster.model.source.JavaClassSource> field)
boolean	isFieldTypeEnum(Project project, org.jboss.forge.roaster.model.source.JavaClassSource targetEntity, String fieldType)
boolean	isFieldTypeEnum(Project project, String fieldType)
void	removeField(org.jboss.forge.roaster.model.source.JavaClassSource targetClass, org.jboss.forge.roaster.model.Field<org.jboss.forge.roaster.model.source.JavaClassSource> field) Removes the field, including its getters and setters and updating toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldOperations

public FieldOperations()

Method Detail

removeField

public void removeField(org.jboss.forge.roaster.model.source.JavaClassSource targetClass,
                        org.jboss.forge.roaster.model.Field<org.jboss.forge.roaster.model.source.JavaClassSource> field)

Removes the field, including its getters and setters and updating toString()

Parameters:

targetClass - The class, which field will be removed

field - The field to be removed

addFieldTo

public org.jboss.forge.roaster.model.source.FieldSource<org.jboss.forge.roaster.model.source.JavaClassSource> addFieldTo(org.jboss.forge.roaster.model.source.JavaClassSource targetClass,
                                                                                                                         String fieldType,
                                                                                                                         String fieldName,
                                                                                                                         String... annotations)

Adds the field with private visibility, including getter and setter, updating the toString()

Parameters:

targetClass - The class which the field will be added to

fieldType - The type of the field

fieldName - The name of the field

annotations - An optional list of annotations that will be added to the field

Returns:

The newly created field

addFieldTo

public org.jboss.forge.roaster.model.source.FieldSource<org.jboss.forge.roaster.model.source.JavaClassSource> addFieldTo(org.jboss.forge.roaster.model.source.JavaClassSource targetClass,
                                                                                                                         String fieldType,
                                                                                                                         String fieldName,
                                                                                                                         org.jboss.forge.roaster.model.Visibility visibility,
                                                                                                                         boolean withGetter,
                                                                                                                         boolean withSetter,
                                                                                                                         boolean updateToString,
                                                                                                                         String... annotations)

Adds the field, updating the toString(). If specified, adds a getter, a setter or both.

Parameters:

targetClass - The class which the field will be added to

fieldType - The type of the field

fieldName - The name of the field

visibility - The visibility of the newly created field

withGetter - Specifies whether accessor method should be created

withSetter - Specifies whether mutator method should be created

updateToString - Specifies whether the field should be added in the toString method

annotations - An optional list of annotations that will be added to the field

Returns:

The newly created field

addFieldTo

public org.jboss.forge.roaster.model.source.FieldSource<org.jboss.forge.roaster.model.source.JavaClassSource> addFieldTo(org.jboss.forge.roaster.model.source.JavaClassSource targetClass,
                                                                                                                         String fieldType,
                                                                                                                         String fieldName,
                                                                                                                         org.jboss.forge.roaster.model.Visibility visibility,
                                                                                                                         boolean withGetter,
                                                                                                                         boolean withSetter,
                                                                                                                         String... annotations)

Adds the field, updating the toString(). If specified, adds a getter, a setter or both.

Parameters:

targetClass - The class which the field will be added to

fieldType - The type of the field

fieldName - The name of the field

visibility - The visibility of the newly created field

withGetter - Specifies whether accessor method should be created

withSetter - Specifies whether mutator method should be created

annotations - An optional list of annotations that will be added to the field

Returns:

The newly created field

canAddFieldToToString

protected boolean canAddFieldToToString(org.jboss.forge.roaster.model.Field<org.jboss.forge.roaster.model.source.JavaClassSource> field)

isFieldTypeEnum

public boolean isFieldTypeEnum(Project project,
                               String fieldType)

Parameters:

project - Project in which the fieldType will be searched

fieldType - Full type of the field with package

Returns:

true if fieldType was found and is enum false otherwise.

Throws:

IllegalArgumentException - if fieldType or project is null

isFieldTypeEnum

public boolean isFieldTypeEnum(Project project,
                               org.jboss.forge.roaster.model.source.JavaClassSource targetEntity,
                               String fieldType)

Parameters:

project - Project in which the fieldType will be searched

fieldType - Type of the field

targetEntity - Entity which package which will be used if fieldType doesn't have package specified

Returns:

true if fieldType was found and is enum false otherwise.

Throws:

IllegalArgumentException - if fieldType or project is null