com.agapsys.security

Class TreeObject<T extends TreeObject>

java.lang.Object

com.agapsys.security.TreeObject<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Role

public class TreeObject<T extends TreeObject>
extends Object
implements Serializable

Represents an object which can contains children objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TreeObject() Constructs an empty object without any children.
TreeObject(Set<T> childrenSet) Constructs an object with a given set of children.

Method Summary

Modifier and Type	Method and Description
void	addChild(T child) Adds an object as a child.
boolean	belongsTo(Set<T> parentSet, boolean recursive) Returns a boolean indicating if this objects is a child of any of the members of given set.
boolean	belongsTo(T parent, boolean recursive) Returns a boolean indicating if this object is a child of given object.
void	clearChildren() Remove all children objects.
boolean	equals(Object obj)
Set<T>	getChildren()
boolean	hasChild(T child, boolean recursive) Returns a boolean indicating if given object is a child of this object.
boolean	hasChildren()
boolean	hasChildren(Set<T> childrenSet, boolean recursive) Returns a boolean indicating if all elements of given set are children of this element.
int	hashCode()
void	removeChild(T child) Removes a direct child.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeObject

public TreeObject()

Constructs an empty object without any children.

TreeObject

public TreeObject(Set<T> childrenSet)
           throws IllegalArgumentException

Constructs an object with a given set of children.

Parameters:

childrenSet - default children to be added

Throws:

IllegalArgumentException - if children == null or children set contains null

Method Detail

getChildren

public final Set<T> getChildren()

Returns:

A read-only set of children.

hasChildren

public final boolean hasChildren()

Returns:

A boolean indicating if this object has children.

hasChild

public final boolean hasChild(T child,
                              boolean recursive)
                       throws IllegalArgumentException

Returns a boolean indicating if given object is a child of this object.

Parameters:

child - object to be tested

recursive - define if children of children shall be searched

Returns:

boolean indicating if given object was added

Throws:

IllegalArgumentException - if child == null

hasChildren

public final boolean hasChildren(Set<T> childrenSet,
                                 boolean recursive)
                          throws IllegalArgumentException

Returns a boolean indicating if all elements of given set are children of this element.

Parameters:

childrenSet - children to check

recursive - define if children of children shall be searched

Returns:

boolean indicating if all elements of given sets are children of this element. Note: a empty set is always contained in a TreeObject

Throws:

IllegalArgumentException - if childrenSet is null

belongsTo

public final boolean belongsTo(T parent,
                               boolean recursive)
                        throws IllegalArgumentException

Returns a boolean indicating if this object is a child of given object.

Parameters:

parent - parent to test

recursive - define if parents of parents shall be searched

Returns:

a boolean indicating if this object is a child of given object

Throws:

IllegalArgumentException - if parent == null

belongsTo

public final boolean belongsTo(Set<T> parentSet,
                               boolean recursive)
                        throws IllegalArgumentException

Returns a boolean indicating if this objects is a child of any of the members of given set.

Parameters:

parentSet - parents to be searched

recursive - define if parents of parents shall be searched

Returns:

boolean with the test result

Throws:

IllegalArgumentException - if parentSet == null

addChild

public final void addChild(T child)
                    throws DuplicateException,
                           IllegalArgumentException,
                           CircularReferenceException

Adds an object as a child.

Parameters:

child - child to be added

Throws:

DuplicateException - if given child was already added as a direct child of this object.

IllegalArgumentException - if child == null

CircularReferenceException - if child.equals(this) or children (direct or indirect) of given child equals to this

removeChild

public final void removeChild(T child)
                       throws IllegalArgumentException

Removes a direct child. If given object is not a direct child, nothing happens.

Parameters:

child - child to be removed.

Throws:

IllegalArgumentException - if child == null

clearChildren

public final void clearChildren()

Remove all children objects.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object