de.javagl.category

Interface MutableCategory<T>

Type Parameters:

T - The type of elements in this category

All Superinterfaces:

Category<T>

public interface MutableCategory<T>
extends Category<T>

Interface for a mutable Category

Method Summary

Modifier and Type	Method and Description
MutableCategory<T>	addChild(String name) Add a new child Category with the given name and return it.
boolean	addElements(Iterable<? extends T> elements) Add the given elements to this Category
MutableCategory<T>	getChild(String name) Returns the child category with the given name, or null if there is no child with the given name.
List<? extends MutableCategory<T>>	getChildren() Returns an unmodifiable (possibly empty) list containing the children of this category.
void	removeAllChildren() Remove all children from this Category.
void	removeAllElements() Remove all elements from this Category.
MutableCategory<T>	removeChild(String name) Remove the child Category with the given name.
boolean	removeElements(Iterable<? extends T> elements) Remove the given elements from this Category

Methods inherited from interface de.javagl.category.Category

addCategoryListener, getElements, getName, removeCategoryListener

Method Detail

addChild

MutableCategory<T> addChild(String name)

Add a new child Category with the given name and return it. If such a child already exists, it will be returned.

Parameters:

name - The name of the child Category

Returns:

The child Category with the given name

removeChild

MutableCategory<T> removeChild(String name)

Remove the child Category with the given name.

Parameters:

name - The name of the child Category to remove

Returns:

The removed child Category, or null if there was not child with the given name

removeAllChildren

void removeAllChildren()

Remove all children from this Category. This will not cause any elements to be removed.

addElements

boolean addElements(Iterable<? extends T> elements)

Add the given elements to this Category

Parameters:

elements - The element to add

Returns:

Whether this Category changed through this action (that is, whether at least one of the elements was not yet present)

removeElements

boolean removeElements(Iterable<? extends T> elements)

Remove the given elements from this Category

Parameters:

elements - The elements to remove

Returns:

Whether this Category changed through this action (that is, whether at least one of the elements was previously contained in this Category)

removeAllElements

void removeAllElements()

Remove all elements from this Category. This will not cause any children to be removed.

getChildren

List<? extends MutableCategory<T>> getChildren()

Returns an unmodifiable (possibly empty) list containing the children of this category. Changes in this category will not affect the returned list. This method specifies the return type to be a MutableCategory

Specified by:

getChildren in interface Category<T>

Returns:

The children of this category

getChild

MutableCategory<T> getChild(String name)

Returns the child category with the given name, or null if there is no child with the given name. This method specifies the return type to be a MutableCategory

Specified by:

getChild in interface Category<T>

Parameters:

name - The name of the child category

Returns:

The child category, or null