de.javagl.category

Class Categories

java.lang.Object

de.javagl.category.Categories

public class Categories
extends Object

Methods related to Category instances

Method Summary

Modifier and Type	Method and Description
static <T> MutableCategory<T>	create(String name) Create a new MutableCategory with the given name
static <T> CategoriesBuilder<T>	createBuilder(String name) Creates a new instance of a CategoriesBuilder, using the given name for the root category.
static <T> Set<T>	getAllElements(Category<T> category) Returns a new set containing all elements of the given Category and its children.
static <T> void	mergeRecursively(MutableCategory<T> target, Category<? extends T> source) Merges the given source Category into the given target Category.
static void	removeEmptyCategories(MutableCategory<?> category) Clean up the given Category.
static String	toFormattedString(Category<?> category) Creates a formatted, multi-line string representation of the given Category.

Methods inherited from class java.lang.Object

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

Method Detail

createBuilder

public static <T> CategoriesBuilder<T> createBuilder(String name)

Creates a new instance of a CategoriesBuilder, using the given name for the root category.

Type Parameters:

T - The type of the elements in the Category

Parameters:

name - The name of the root Category

Returns:

The CategoriesBuilder instance

create

public static <T> MutableCategory<T> create(String name)

Create a new MutableCategory with the given name

Type Parameters:

T - The type of the elements in the Category

Parameters:

name - The name of the Category

Returns:

The new MutableCategory

getAllElements

public static <T> Set<T> getAllElements(Category<T> category)

Returns a new set containing all elements of the given Category and its children.

Type Parameters:

T - The type of the elements in the Category

Parameters:

category - The category to collect all elements from

Returns:

The set of all elements of the given category and its children

mergeRecursively

public static <T> void mergeRecursively(MutableCategory<T> target,
                                        Category<? extends T> source)

Merges the given source Category into the given target Category. This merge will be performed recursively for all sub-categories.

Type Parameters:

T - The type of the elements in the Category

Parameters:

target - The MutableCategory to which the other will be added

source - The source Category

removeEmptyCategories

public static void removeEmptyCategories(MutableCategory<?> category)

Clean up the given Category. That is, this method will recursively remove all categories from the given hierarchy that have neither children nor elements.

Parameters:

category - The Category to clean up

toFormattedString

public static String toFormattedString(Category<?> category)

Creates a formatted, multi-line string representation of the given Category.

The exact format of this string is unspecified!

This method is mainly intended for debugging.

Parameters:

category - The Category

Returns:

The string representation