Uses of Class
org.apache.rat.config.parameters.Description

Packages that use Description

Package	Description
org.apache.rat.analysis	Classes that perform analyses of files.
org.apache.rat.config.parameters	Classes that manage information about parameters for builders, matchers and similar components.
org.apache.rat.documentation.velocity	Contains velocity based tools and accessories.

Uses of Description in org.apache.rat.analysis

Methods in org.apache.rat.analysis that return Description

Modifier and Type	Method	Description
default Description	IHeaderMatcher.Builder.getDescription()	Gets the description for this builder.
default Description	IHeaderMatcher.getDescription()	Generates the component Description.

Uses of Description in org.apache.rat.config.parameters

Methods in org.apache.rat.config.parameters that return Description

Modifier and Type	Method	Description
static Description	DescriptionBuilder.build(Object object)	Create the description for the object.
static Description	DescriptionBuilder.buildMap(Class<?> clazz)	Create a description for a class.

Methods in org.apache.rat.config.parameters that return types with arguments of type Description

Modifier and Type	Method	Description
Collection<Description>	Description.childrenOfType(ComponentType type)	Get all the children of a specific type
Collection<Description>	Description.filterChildren(Predicate<Description> filter)	Gets a filtered collection of the child descriptions.
Map<String,Description>	Description.getChildren()	Gets a map of the parameters that the object contains.

Method parameters in org.apache.rat.config.parameters with type arguments of type Description

Modifier and Type	Method	Description
Collection<Description>	Description.filterChildren(Predicate<Description> filter)	Gets a filtered collection of the child descriptions.

Constructor parameters in org.apache.rat.config.parameters with type arguments of type Description

Modifier	Constructor	Description
	Description(ComponentType type, String name, String desc, boolean isCollection, Class<?> childClass, Collection<Description> children, boolean required)	Constructor.
	Description(ConfigComponent configComponent, boolean isCollection, Class<?> childClass, Collection<Description> children)	Constructor

Uses of Description in org.apache.rat.documentation.velocity

Methods in org.apache.rat.documentation.velocity that return Description

Modifier and Type	Method	Description
Description	MatcherTree.getRoot()	Gets the description of the root of the tree.

Methods in org.apache.rat.documentation.velocity that return types with arguments of type Description

Modifier and Type	Method	Description
List<Description>	RatTool.licenseProperties()	Gets a list of license property descriptions.