oracle.javatools.patterns

Interface Parent<C>

Type Parameters:

C - the type of children contained in this parent

public interface Parent<C>

The Parent interface defines the contract for an object that may contain one or more child objects.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(C child) Add the given child to this parent object.
int	childCount() Get the number of children for this parent object.
boolean	containsChild(C child) Returns true if the given child object has been added to this parent.
java.util.Collection<C>	getChildren() Get the children for this parent object.
boolean	hasChildren() Returns true if this parent has at least one (1) child.
boolean	removeChild(C child) Remove the given child from this parent.

Method Detail

getChildren

java.util.Collection<C> getChildren()

Get the children for this parent object.

Returns:

the children for this parent object

addChild

boolean addChild(C child)

Add the given child to this parent object. If the child has already been added to this parent, then this method has no effect.

Implementors should document whether their implementation will automatically set the parent value of the child if the given child implements the Child interface.

Parameters:

child - the child to be added to this parent

Returns:

true if the given child was added to this parent, false otherwise

hasChildren

boolean hasChildren()

Returns true if this parent has at least one (1) child.

Returns:

true if this parent has at least one (1) child, false otherwise

containsChild

boolean containsChild(C child)

Returns true if the given child object has been added to this parent.

Parameters:

child - the child object

Returns:

true if the given child object has been added to this parent, false otherwise

removeChild

boolean removeChild(C child)

Remove the given child from this parent. If the child has not already been added to this parent, then this method has no effect.

Implementors should document whether their implementation will automatically clear the parent value of the child if the given child implements the Child interface.

Parameters:

child - the child to be removed

Returns:

true if the child was removed from this parent, false otherwise

childCount

int childCount()

Get the number of children for this parent object.

Returns:

the number of children for this parent object