de.javagl.category

Class CategoriesBuilder<T>

java.lang.Object

de.javagl.category.CategoriesBuilder<T>

Type Parameters:

T - The type of elements for the Category

public final class CategoriesBuilder<T>
extends Object

A builder for Category hierarchies:

 CategoriesBuilder<Type> b = Categories.createBuilder("Root");
 b.add(elementForRoot);
 b.get("FirstChild").add(someElementForFirstChild);
 b.get("FirstChild").add(someOtherElementForFirstChild);
 b.get("SecondChild").add(ElementForSecondChild);
 b.get("SecondChild").get("GrandChild").add(lastElement);
 Category<Type> root = b.get();
 

This class essentially wraps a MutableCategory and offers convenience functions for the initial construction of the categories, for example, by creating the child categories on demand.

Method Summary

Modifier and Type	Method and Description
CategoriesBuilder<T>	add(T element) Add the given element to the category represented by this builder.
CategoriesBuilder<T>	addAll(Iterable<? extends T> elements) Add the given elements to the category represented by this builder.
CategoriesBuilder<T>	addIfUncategorized(String name, Iterable<? extends T> candidates) Add each of the given elements to a category with the given name iff it is not already contained in the current category or any of its children.
MutableCategory<T>	get() Returns the MutableCategory that is currently being built
CategoriesBuilder<T>	get(String name) Returns a builder for the sub-category with the given name.
CategoriesBuilder<T>	mergeRecursively(Category<? extends T> other) Merges the given Category with the Category that is currently being built.

Methods inherited from class java.lang.Object

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

Method Detail

add

public CategoriesBuilder<T> add(T element)

Add the given element to the category represented by this builder.

Parameters:

element - The element to add

Returns:

This builder

addAll

public CategoriesBuilder<T> addAll(Iterable<? extends T> elements)

Add the given elements to the category represented by this builder.

Parameters:

elements - The elements to add

Returns:

This builder

get

public CategoriesBuilder<T> get(String name)

Returns a builder for the sub-category with the given name. If the respective sub-category does not exist, it will be created.

Parameters:

name - The name of the sub-category

Returns:

The builder for the sub-category

mergeRecursively

public CategoriesBuilder<T> mergeRecursively(Category<? extends T> other)

Merges the given Category with the Category that is currently being built. This merge will be performed recursively for all sub-categories.

Parameters:

other - The other Category

Returns:

This builder

addIfUncategorized

public CategoriesBuilder<T> addIfUncategorized(String name,
                                               Iterable<? extends T> candidates)

Add each of the given elements to a category with the given name iff it is not already contained in the current category or any of its children.

Parameters:

name - The category name

candidates - The candidates to add, if they are not yet contained somewhere in the category hierarchy

Returns:

This builder

get

public MutableCategory<T> get()

Returns the MutableCategory that is currently being built

Returns:

The MutableCategory