Package org.openrewrite.config

Class CategoryTree<G>

java.lang.Object

org.openrewrite.config.CategoryTree<G>

Type Parameters:

G - A grouping key that can cross category boundaries. Must implement Object.equals(java.lang.Object) and Object.hashCode(), but there is otherwise no restriction on the type. For example, a grouping key could be a String that represents a GAV coordinate of a recipe artifact that contributes recipes to multiple categories.

Direct Known Subclasses:

CategoryTree.Root

public class CategoryTree<G>
extends Object

A hierarchical listing of recipe categories and the recipes that are contained inside them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CategoryTree.PrintNameStyle
static class	CategoryTree.PrintOptions
static class	CategoryTree.Root<G>

Method Summary

Modifier and Type	Method	Description
static <G> CategoryTree.Root<G>	build()
Collection<CategoryTree<G>>	getCategories()
Collection<CategoryTree<G>>	getCategories(boolean omitCategoryRoots, boolean omitEmptyCategories)	Used to recursively navigate the whole category tree without any advance knowledge of what categories exist.
@Nullable CategoryTree<G>	getCategory(String subcategory)
@Nullable CategoryTree<G>	getCategory(String... subcategories)
CategoryTree<G>	getCategoryOrThrow(String subcategory)
CategoryTree<G>	getCategoryOrThrow(String... subcategories)
CategoryDescriptor	getDescriptor()
@Nullable RecipeDescriptor	getRecipe(String id)
Integer	getRecipeCount()
G	getRecipeGroup(String id)
Collection<RecipeDescriptor>	getRecipes()
Map<G,Collection<RecipeDescriptor>>	getRecipesByGroup()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

build

public static <G> CategoryTree.Root<G> build()

getDescriptor

public CategoryDescriptor getDescriptor()

getRecipeCount

public Integer getRecipeCount()

getCategory

@Nullable
public @Nullable CategoryTree<G> getCategory(String subcategory)

getCategory

@Nullable
public @Nullable CategoryTree<G> getCategory(String... subcategories)

getCategoryOrThrow

public CategoryTree<G> getCategoryOrThrow(String subcategory)

getCategoryOrThrow

public CategoryTree<G> getCategoryOrThrow(String... subcategories)

getRecipe

@Nullable
public @Nullable RecipeDescriptor getRecipe(String id)

getRecipeGroup

@Nullable
public G getRecipeGroup(String id)

getRecipes

public Collection<RecipeDescriptor> getRecipes()

getRecipesByGroup

public Map<G,Collection<RecipeDescriptor>> getRecipesByGroup()

getCategories

public Collection<CategoryTree<G>> getCategories()

getCategories

public Collection<CategoryTree<G>> getCategories(boolean omitCategoryRoots,
 boolean omitEmptyCategories)

Used to recursively navigate the whole category tree without any advance knowledge of what categories exist.

Returns:

The subcategories of this category.

toString

public String toString()

Overrides:

toString in class Object