org.refcodes.criteria.impls

Class AbstractSingleCriteriaNode

java.lang.Object

org.refcodes.criteria.impls.AbstractCriteria

org.refcodes.criteria.impls.AbstractSingleCriteriaNode

All Implemented Interfaces:

Criteria, CriteriaNode, SingleCriteriaNode, NameAccessor

public abstract class AbstractSingleCriteriaNode
extends AbstractCriteria
implements SingleCriteriaNode

Base class with the base SingleCriteriaNode functionality provided for SingleCriteriaNode implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

NameAccessor.NameBuilder<B extends NameAccessor.NameBuilder<B>>, NameAccessor.NameMutator, NameAccessor.NameProperty

Constructor Summary

Constructors

Constructor and Description
AbstractSingleCriteriaNode(String aName) Constructs a SingleCriteriaNode with the given name.
AbstractSingleCriteriaNode(String aName, Criteria aChild) Constructs a SingleCriteriaNode with the given name and the provided Criteria child.

Method Summary

Modifier and Type	Method and Description
void	addChild(Criteria aCriteria) Adds a child Criteria to the CriteriaNode.
Criteria	getChild() Returns the single child Criteria being stored in this CriteriaNode.
List<Criteria>	getChildren() Returns the list of child Criteria instances contained in the CriteriaNode.
void	setChild(Criteria aChild) Sets the single child Criteria to be stored in this CriteriaNode.

Methods inherited from class org.refcodes.criteria.impls.AbstractCriteria

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.NameAccessor

getName

Constructor Detail

AbstractSingleCriteriaNode

public AbstractSingleCriteriaNode(String aName)

Constructs a SingleCriteriaNode with the given name.

Parameters:

aName - The name of the SingleCriteriaNode.

AbstractSingleCriteriaNode

public AbstractSingleCriteriaNode(String aName,
                                  Criteria aChild)

Constructs a SingleCriteriaNode with the given name and the provided Criteria child.

Parameters:

aName - The name of the SingleCriteriaNode.

aChild - The Criteria child to be contained in the SingleCriteriaNode.

Method Detail

getChild

public Criteria getChild()

Description copied from interface: SingleCriteriaNode

Returns the single child Criteria being stored in this CriteriaNode.

Specified by:

getChild in interface SingleCriteriaNode

Returns:

The according child Criteria.

setChild

public void setChild(Criteria aChild)

Description copied from interface: SingleCriteriaNode

Sets the single child Criteria to be stored in this CriteriaNode.

Specified by:

setChild in interface SingleCriteriaNode

Parameters:

aChild - The according child Criteria.

addChild

public void addChild(Criteria aCriteria)
              throws IllegalStateException,
                     IllegalArgumentException

Adds a child Criteria to the CriteriaNode. In case a specialized CriteriaNode applies constraints on the number or type of Criteria which may be added, an according exception may be thrown. For example the SingleCriteriaNode applies constraints on this method. ------------------------------------------------------------------------- CAUTION: Adding more than one Criteria child will result in an IllegalStateException to be thrown! -------------------------------------------------------------------------

Specified by:

addChild in interface CriteriaNode

Parameters:

aCriteria - The child Criteria to be added.

Throws:

IllegalStateException - In case constraints in terms of state are violated, implementation depended.

IllegalArgumentException - In case constraints in terms of argument are violated, implementation depended.

getChildren

public List<Criteria> getChildren()

Description copied from interface: CriteriaNode

Returns the list of child Criteria instances contained in the CriteriaNode.

Specified by:

getChildren in interface CriteriaNode

Returns:

The Criteria instances contained in the CriteriaNode.