Package org.apache.rat.tools

Class AntOption.ExampleGenerator

java.lang.Object

org.apache.rat.tools.AntOption.ExampleGenerator

Enclosing class:

AntOption

public class AntOption.ExampleGenerator
extends Object

An example code generator for this AntOption.

Constructor Summary

Constructors

Constructor	Description
ExampleGenerator()	The constructor.

Method Summary

Modifier and Type	Method	Description
String	getChildElements(String data, List<String> childElements)	Creates a string comprising the child elements for the Ant XML report call.
String	getExample(String data, Map<String,String> attributes, List<String> childElements)	Gets an example Ant XML report call using ant option with the specified attributes and child elements.
String	getExampleAttributes(String data, Map<String,String> attributes)	Creates a string comprising the attributes for the Ant XML report call.

Methods inherited from class java.lang.Object

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

Constructor Details

ExampleGenerator

public ExampleGenerator()

The constructor.

Method Details

getExample

public String getExample(String data,
 Map<String,String> attributes,
 List<String> childElements)

Gets an example Ant XML report call using ant option with the specified attributes and child elements.

Parameters:

data - The data value for this option.

attributes - A map of attribute keys and values.

childElements - a list of child elements for the example

Returns:

getExampleAttributes

public String getExampleAttributes(String data,
 Map<String,String> attributes)

Creates a string comprising the attributes for the Ant XML report call.

Parameters:

data - The data value for this option.

attributes - A map of attribute keys and values.

Returns:

a string comprising all the attribute keys and values for the Ant XML report element.

getChildElements

public String getChildElements(String data,
 List<String> childElements)

Creates a string comprising the child elements for the Ant XML report call.

Parameters:

data - the data for this option.

childElements - additional child elements.

Returns:

A string comprising the child elements for the Ant XML report call.