Package org.apache.rat.tools

Class AntOption

java.lang.Object

org.apache.rat.tools.AbstractOption

org.apache.rat.tools.AntOption

public class AntOption
extends AbstractOption

A class that wraps the CLI option and provides Ant specific values.

Field Summary

Fields inherited from class org.apache.rat.tools.AbstractOption

name, option, PATTERN

Method Summary

Modifier and Type	Method	Description
protected String	cleanupName(org.apache.commons.cli.Option option)
String	getAttributeFunctionName()	Get the signature of the attribute function.
String	getComment(boolean addParam)	Get the method comment for this option.
boolean	isAttribute()	Returns true if the option should be an attribute of the <rat:report> element.
boolean	isElement()	Returns true if the option should be a child element of the <rat:report> element.

Methods inherited from class org.apache.rat.tools.AbstractOption

cleanup, getArgName, getDefaultValue, getDeprecated, getDescription, getName, getType, hasArg, hasArgs, isDeprecated, isRequired, keyValue

Methods inherited from class java.lang.Object

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

Method Details

isAttribute

public boolean isAttribute()

Returns true if the option should be an attribute of the <rat:report> element.

Returns:

true if the option should be an attribute of the <rat:report> element.

isElement

public boolean isElement()

Returns true if the option should be a child element of the <rat:report> element.

Returns:

true if the option should be a child element of the <rat:report> element.

cleanupName

protected String cleanupName(org.apache.commons.cli.Option option)

Specified by:

cleanupName in class AbstractOption

getComment

public String getComment(boolean addParam)

Get the method comment for this option.

Parameters:

addParam - if true the param annotation is added.

Returns:

the Comment block for the function.

getAttributeFunctionName

public String getAttributeFunctionName()

Get the signature of the attribute function.

Returns:

the signature of the attribute function.