br.edu.ufcg.splab.designtests.designrules

Class AbstractDesignRule

java.lang.Object

br.edu.ufcg.splab.designtests.designrules.AbstractDesignRule

All Implemented Interfaces:

org.designwizard.designrules.Rule

Direct Known Subclasses:

HashCodeAndEqualsNotUseIdentifierPropertyRule, HashCodeAndEqualsRule, ImplementsSerializableRule, NoArgumentConstructorRule, NoFinalClassRule, ProvideGetsSetsFieldsRule, ProvideIdentifierPropertyRule, UseInterfaceSetOrListRule, UseListCollectionRule, UseSetCollectionRule

public abstract class AbstractDesignRule
extends Object
implements org.designwizard.designrules.Rule

Abstract class to start the properties of the rules for software design in instance of the DesignWizard.

Author:

Taciano Morais Silva - tacianosilva@gmail.com

Constructor Summary

Constructors

Constructor and Description
AbstractDesignRule(org.designwizard.api.DesignWizard dw) Initiates rule properties for software design in instance of the DesignWizard.
AbstractDesignRule(org.designwizard.api.DesignWizard dw, Set<org.designwizard.design.ClassNode> classes) Initiates rule properties for software design in instance of the DesignWizard.

Method Summary

Modifier and Type	Method and Description
protected void	addReport(String messages) Add new errors messages at the report.
protected void	addResultFalse(org.designwizard.design.ClassNode node) Add a ClassNode in the set of false results.
protected void	addResultTrue(org.designwizard.design.ClassNode node) Add a ClassNode in the set of true results.
protected boolean	checkClassNodes(Set<org.designwizard.design.ClassNode> classes) Checks if the parameter belongs to the set of classes of the design DesignWizard.getAllClasses().
abstract boolean	checkRule() Checks if the set getClassNodes() attends the rule.
Set<org.designwizard.design.ClassNode>	getClassNodes() Returns the set of ClassNode objects where this design rule will be executed.
protected org.designwizard.api.DesignWizard	getDesignWizard() Returns a DesignWizard's instance with the design.
protected org.designwizard.design.MethodNode	getEqualsMethod(org.designwizard.design.ClassNode classNode) Returns a MethodNode object that reflects the specified equals method of the class or superClass represented by ClassNode object.
protected org.designwizard.design.MethodNode	getHashCodeMethod(org.designwizard.design.ClassNode classNode) Returns a MethodNode object that reflects the specified hashCode method of the class or superClass represented by ClassNode object.
protected org.designwizard.design.MethodNode	getMethod(org.designwizard.design.ClassNode classNode, String methodName) Returns a MethodNode object that reflects the specified method of the class or interface represented by ClassNode object.
String	getName() Returns the rule's name.
org.designwizard.design.ClassNode	getObjectClass() ClassNode for represents the Object class.
String	getReport() The Report with errors messages.
Set<org.designwizard.design.ClassNode>	getResultsFalse() Returns the set of ClassNode objects that did not pass the rule.
Set<org.designwizard.design.ClassNode>	getResultsTrue() Returns the set of ClassNode objects that passed the rule.
protected boolean	hasGetMethod(org.designwizard.design.FieldNode fieldNode, org.designwizard.design.ClassNode entityNode) Verifies if exists get method for the field.
protected boolean	hasSetMethod(org.designwizard.design.FieldNode fieldNode, org.designwizard.design.ClassNode entityNode) Verifies if exists set method for the field.
boolean	isCollection(org.designwizard.design.ClassNode node) Checks if the classNode implements or inherits from the Collection type of the Java Collection Framework.
boolean	isEmptyReport() Checks if the report is empty.
boolean	isList(org.designwizard.design.ClassNode node) Checks if the classNode implements or inherits from the List type of the Java Collection Framework.
boolean	isSet(org.designwizard.design.ClassNode node) Checks if the classNode implements or inherits from the Set type of the Java Collection Framework.
void	setClassNode(org.designwizard.design.ClassNode classe) Put a ClassNode object where this design rule will be executed.
void	setClassNodes(Set<org.designwizard.design.ClassNode> classes) Put a set of ClassNode objects where this design rule will be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDesignRule

public AbstractDesignRule(org.designwizard.api.DesignWizard dw)

Initiates rule properties for software design in instance of the DesignWizard.

Parameters:

dw - The instance of the DesignWizard with the software design.

AbstractDesignRule

public AbstractDesignRule(org.designwizard.api.DesignWizard dw,
                          Set<org.designwizard.design.ClassNode> classes)

Initiates rule properties for software design in instance of the DesignWizard.

Parameters:

dw - The instance of the DesignWizard with the software design.

classes - The set of ClassNode that the rule will be executing.

Method Detail

getName

public final String getName()

Returns the rule's name.

Returns:

The rule's name.

getObjectClass

public final org.designwizard.design.ClassNode getObjectClass()

ClassNode for represents the Object class.

Returns:

A ClassNode for java.lang.Object.

getDesignWizard

protected final org.designwizard.api.DesignWizard getDesignWizard()

Returns a DesignWizard's instance with the design.

Returns:

A DesignWizard's instance with the design.

checkRule

public abstract boolean checkRule()

Checks if the set getClassNodes() attends the rule.

Specified by:

checkRule in interface org.designwizard.designrules.Rule

Returns:

True if all classNodes attends the rule.

See Also:

Rule.checkRule()

getResultsTrue

public final Set<org.designwizard.design.ClassNode> getResultsTrue()

Returns the set of ClassNode objects that passed the rule.

Returns:

A set of ClassNode objects or set empty.

getResultsFalse

public final Set<org.designwizard.design.ClassNode> getResultsFalse()

Returns the set of ClassNode objects that did not pass the rule.

Returns:

A set of ClassNode objects or set empty.

addResultTrue

protected final void addResultTrue(org.designwizard.design.ClassNode node)

Add a ClassNode in the set of true results.

Parameters:

node - The classNode that passed the rule.

addResultFalse

protected final void addResultFalse(org.designwizard.design.ClassNode node)

Add a ClassNode in the set of false results.

Parameters:

node - The classNode that did not pass the rule.

hasSetMethod

protected final boolean hasSetMethod(org.designwizard.design.FieldNode fieldNode,
                                     org.designwizard.design.ClassNode entityNode)

Verifies if exists set method for the field.

Parameters:

fieldNode - The field contained in the class.

entityNode - Entity that contains the field.

Returns:

True if exists set method in the entity for the field.

hasGetMethod

protected final boolean hasGetMethod(org.designwizard.design.FieldNode fieldNode,
                                     org.designwizard.design.ClassNode entityNode)

Verifies if exists get method for the field.

Parameters:

fieldNode - The field contained in the class.

entityNode - Entity that contains the field.

Returns:

True if exists get method in the entity for the field.

getClassNodes

public final Set<org.designwizard.design.ClassNode> getClassNodes()

Returns the set of ClassNode objects where this design rule will be executed.

Returns:

A set of ClassNode objects or set empty.

setClassNodes

public final void setClassNodes(Set<org.designwizard.design.ClassNode> classes)

Put a set of ClassNode objects where this design rule will be executed.

Parameters:

classes - A set of ClassNode objects.

setClassNode

public final void setClassNode(org.designwizard.design.ClassNode classe)

Put a ClassNode object where this design rule will be executed.

Parameters:

classe - A ClassNode objects where this design rule will be executed.

checkClassNodes

protected final boolean checkClassNodes(Set<org.designwizard.design.ClassNode> classes)

Checks if the parameter belongs to the set of classes of the design DesignWizard.getAllClasses().

Parameters:

classes - The set of classNodes to check the pertinence.

Returns:

True if all classnodes belongs to the design. False if classes is null or DesignWizard.getAllClasses() is null.

getReport

public final String getReport()

The Report with errors messages.

Specified by:

getReport in interface org.designwizard.designrules.Rule

Returns:

A string with errors messages.

isEmptyReport

public final boolean isEmptyReport()

Checks if the report is empty.

Returns:

True if it's empty.

addReport

protected final void addReport(String messages)

Add new errors messages at the report.

Parameters:

messages - A string with errors messages.

isCollection

public final boolean isCollection(org.designwizard.design.ClassNode node)

Checks if the classNode implements or inherits from the Collection type of the Java Collection Framework.

Parameters:

node - A classNode.

Returns:

True if the classNode implements or inherits from the Collection type.

isSet

public final boolean isSet(org.designwizard.design.ClassNode node)

Checks if the classNode implements or inherits from the Set type of the Java Collection Framework.

Parameters:

node - A classNode.

Returns:

True if the classNode implements or inherits from the Set type.

isList

public final boolean isList(org.designwizard.design.ClassNode node)

Checks if the classNode implements or inherits from the List type of the Java Collection Framework.

Parameters:

node - A classNode.

Returns:

True if the classNode implements or inherits from the List type.

getMethod

protected final org.designwizard.design.MethodNode getMethod(org.designwizard.design.ClassNode classNode,
                                                             String methodName)

Returns a MethodNode object that reflects the specified method of the class or interface represented by ClassNode object. The name parameter is a String specifying the simple name of the desired method.

Parameters:

classNode - the ClassNode object that reflects the specified method.

methodName - the method name.

Returns:

the MethodNode object of this class specified by name or null if a method with the specified name is not found.

getEqualsMethod

protected final org.designwizard.design.MethodNode getEqualsMethod(org.designwizard.design.ClassNode classNode)

Returns a MethodNode object that reflects the specified equals method of the class or superClass represented by ClassNode object.

Parameters:

classNode - the ClassNode object that reflects the specified method.

Returns:

the MethodNode object of this class specified by name or null if a method with the specified name is not found.

getHashCodeMethod

protected final org.designwizard.design.MethodNode getHashCodeMethod(org.designwizard.design.ClassNode classNode)

Returns a MethodNode object that reflects the specified hashCode method of the class or superClass represented by ClassNode object.

Parameters:

classNode - the ClassNode object that reflects the specified method.

Returns:

the MethodNode object of this class specified by name or null if a method with the specified name is not found.