Package org.eclipse.aether.tools

Class CollectConfiguration

java.lang.Object

org.eclipse.aether.tools.CollectConfiguration

All Implemented Interfaces:

Callable<Integer>

public class CollectConfiguration
extends Object
implements Callable<Integer>

This tool is used both from Resolver as well as from Maven to generate documentation for configuration keys. It scans the source files under a given root directory, collects the configuration keys declared in them and renders them into Velocity templates. It relies on javadoc with a custom doclet to extract the configuration keys from the source files. The doclet writes the discovered keys into an intermediate properties file, which is then read back and used to render the Velocity templates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CollectConfiguration.Mode	The mode of the generator, i.e.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIGURATION_MARKER	Javadoc block tag marking a constant field as a configuration key.
protected static final List<String>	FIELDS	The metadata fields collected per configuration key and written to / read from the intermediate properties file.
protected static final String	KEY
protected static final String	MAVEN_CONFIGURATION_MARKER	Text marker used to pre-select the source files to feed the doclet when scanning Maven sources.
protected CollectConfiguration.Mode	mode
protected Path	outputDirectory
protected Path	rootDirectory
protected List<String>	templates

Constructor Summary

Constructors

Constructor	Description
CollectConfiguration()

Method Summary

Modifier and Type	Method	Description
Integer	call()
static void	main(String[] args)
protected List<Map<String,String>>	readDiscoveredKeys(Path intermediateFile)	Reads back the intermediate properties file produced by ConfigurationCollectorDoclet into the list of maps consumed by the Velocity templates.
protected void	render(List<Map<String,String>> discoveredKeys)
protected void	runDoclet(Path intermediateFile)	Collects the source files under rootDirectory and runs ConfigurationCollectorDoclet against them, having it write the discovered configuration keys into the given intermediate properties file.

Methods inherited from class java.lang.Object

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

Field Details

KEY

protected static final String KEY

See Also:

• Constant Field Values

FIELDS

protected static final List<String> FIELDS

The metadata fields collected per configuration key and written to / read from the intermediate properties file.

CONFIGURATION_MARKER

protected static final String CONFIGURATION_MARKER

Javadoc block tag marking a constant field as a configuration key.

See Also:

• Constant Field Values

MAVEN_CONFIGURATION_MARKER

protected static final String MAVEN_CONFIGURATION_MARKER

Text marker used to pre-select the source files to feed the doclet when scanning Maven sources. Maven declares configuration keys via the org.apache.maven.api.annotations.Config annotation.

See Also:

• Constant Field Values

mode

protected CollectConfiguration.Mode mode

templates

protected List<String> templates

rootDirectory

protected Path rootDirectory

outputDirectory

protected Path outputDirectory

Constructor Details

CollectConfiguration

public CollectConfiguration()

Method Details

main

public static void main(String[] args)

call

public Integer call()

Specified by:

call in interface Callable<Integer>

runDoclet

protected void runDoclet(Path intermediateFile)
                  throws Exception

Collects the source files under rootDirectory and runs ConfigurationCollectorDoclet against them, having it write the discovered configuration keys into the given intermediate properties file.

Throws:

Exception

readDiscoveredKeys

protected List<Map<String,String>> readDiscoveredKeys(Path intermediateFile)
                                               throws Exception

Reads back the intermediate properties file produced by ConfigurationCollectorDoclet into the list of maps consumed by the Velocity templates.

Throws:

Exception

render

protected void render(List<Map<String,String>> discoveredKeys)
               throws Exception

Throws:

Exception