Package org.apache.rat.config.parameters

Class DescriptionBuilder

java.lang.Object

org.apache.rat.config.parameters.DescriptionBuilder

public final class DescriptionBuilder
extends Object

Builds Description objects for the various component instances.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

build

public static Description build(Object object)

Create the description for the object. The object must have a ConfigComponent annotation or null will be returned.

Parameters:

object - the object to process.

Returns:

the Description of the object.

getBuiltClass

public static Class<?> getBuiltClass(Class<? extends IHeaderMatcher.Builder> clazz)

buildMap

public static Description buildMap(Class<?> clazz)

Create a description for a class.

Parameters:

clazz - the class to build the description for.

Returns:

the Description of the class or null if no ConfigComponent annotation was found on the class.