de.javagl.category

Interface Category<T>

Type Parameters:

T - The type of elements in this category

All Known Subinterfaces:

MutableCategory<T>

public interface Category<T>

Interface for a category that contains elements and is part of a hierarchy. Category hierarchies can be constructed using a CategoriesBuilder or using the methods from the Categories class.

Method Summary

Modifier and Type	Method and Description
void	addCategoryListener(CategoryListener<T> listener) Add the given CategoryListener to be informed about changes in this category or any of its children.
Category<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 Category<T>>	getChildren() Returns an unmodifiable (possibly empty) list containing the children of this category.
List<T>	getElements() Returns an unmodifiable (possibly empty) list containing the elements that belong to this category.
String	getName() Returns the name of this category.
void	removeCategoryListener(CategoryListener<T> listener) Remove the given CategoryListener from this category

Method Detail

getName

String getName()

Returns the name of this category. This should be a short, human-readable string summarizing the purpose of all elements that are contained in this category.

Returns:

The name of this category

getChildren

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

Returns an unmodifiable (possibly empty) list containing the children of this category. Changes in this category will not affect the returned list.

Returns:

The children of this category

getChild

Category<T> getChild(String name)

Returns the child category with the given name, or null if there is no child with the given name.

Parameters:

name - The name of the child category

Returns:

The child category, or null

getElements

List<T> getElements()

Returns an unmodifiable (possibly empty) list containing the elements that belong to this category. Changes in this category will not affect the returned list.

Returns:

The elements of this category

addCategoryListener

void addCategoryListener(CategoryListener<T> listener)

Add the given CategoryListener to be informed about changes in this category or any of its children.

Parameters:

listener - The CategoryListener to add

removeCategoryListener

void removeCategoryListener(CategoryListener<T> listener)

Remove the given CategoryListener from this category

Parameters:

listener - The CategoryListener to remove