Index (Apache Creadur RAT::Tools 0.17 API)

A C D E F G H I K L M N O P R S T V W X
All Classes|All Packages

A

AbstractOption - Class in org.apache.rat.documentation.options: Abstract class that provides the framework for UI-specific RAT options.
AntDocumentation - Class in org.apache.rat.tools: A simple tool to convert CLI options into an Ant report base class.
AntGenerator - Class in org.apache.rat.tools: A simple tool to convert CLI options into an Ant report base class.
AntGenerator.GenerateType - Class in org.apache.rat.tools
AntOption - Class in org.apache.rat.documentation.options: A class that wraps the CLI option and provides Ant specific values.
AntOption(Option) - Constructor for class org.apache.rat.documentation.options.AntOption: Constructor.
AntOption.ExampleGenerator - Class in org.apache.rat.documentation.options: An example code generator for this AntOption.
antOptions() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a map client option name to Ant Option.
aptEscape(String) - Method in class org.apache.rat.documentation.velocity.RatTool: Escapes a string for APT (almost plain text).
argCount() - Method in class org.apache.rat.documentation.options.AbstractOption: Returns the number of arguments.
argumentType - Variable in class org.apache.rat.documentation.options.AbstractOption: The argument type for this option
argumentTypes() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of argument types.
ArgumentTypes - Class in org.apache.rat.tools: A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.
attribute(String, String...) - Method in class org.apache.rat.tools.xsd.XsdWriter: Writes the attributes
ATTRIBUTE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An attribute

C

CHOICE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A choice
cleanup(String) - Method in class org.apache.rat.documentation.options.AbstractOption: Replaces CLI pattern options with implementation specific pattern options.
cleanupName() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets this option's cleaned up name.
cleanupName(Option) - Method in class org.apache.rat.documentation.options.AbstractOption: Provide means to wrap the given option depending on the UI-specific option implementation.
cleanupName(Option) - Method in class org.apache.rat.documentation.options.AntOption
cleanupName(Option) - Method in class org.apache.rat.documentation.options.CLIOption
cleanupName(Option) - Method in class org.apache.rat.documentation.options.MavenOption
CLIOption - Class in org.apache.rat.documentation.options
CLIOption(Option) - Constructor for class org.apache.rat.documentation.options.CLIOption
cliOptions() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a map client option name to CLI Option.
close(XsdWriter.Type) - Method in class org.apache.rat.tools.xsd.XsdWriter: Closes (Ends) the element for the type.
COMPLEX - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A complex type
COMPLEX_CONTENT - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A complex type
convertedFrom() - Method in class org.apache.rat.documentation.options.AntOption: Gets the set of options that are mapped to this option.
createName(Option) - Static method in class org.apache.rat.documentation.options.AntOption
createName(Option) - Static method in class org.apache.rat.documentation.options.CLIOption

D

Documentation - Class in org.apache.rat.tools: Generates text based documentation for Licenses, LicenceFamilies, and Matchers.
doubleLine() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets two new lines.

E

ELEMENT - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An element
environmentVariables() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of environment variables.
ExampleGenerator() - Constructor for class org.apache.rat.documentation.options.AntOption.ExampleGenerator: The constructor.
execute() - Method in class org.apache.rat.tools.AntDocumentation
Exporter - Class in org.apache.rat.documentation: Uses Apache Velocity to write a document containing RAT configuration information.
Exporter() - Constructor for class org.apache.rat.documentation.Exporter
EXTENSION - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An extension

F

family() - Method in class org.apache.rat.documentation.velocity.License: Gets the family name of this license.
finish() - Method in class org.apache.rat.tools.xsd.XsdWriter: Finishes the process.

G

getActualAntOption() - Method in class org.apache.rat.documentation.options.AntOption: If this option is converted to another option return that option otherwise return this option.
getAntOptions() - Static method in class org.apache.rat.documentation.options.AntOption: Gets the list of all available Ant options.
getArgName() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the argument name if there is one.
getArgType() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the argument type if there is one.
getAttributeFunctionName() - Method in class org.apache.rat.documentation.options.AntOption: Get the signature of the attribute function.
getAttributes() - Method in class org.apache.rat.documentation.velocity.Matcher: Gets the attributes of this matcher.
getAttributes() - Method in class org.apache.rat.documentation.velocity.MatcherTree.Node: Gets the attributes only if they have values.
getChildElements(String, List<String>) - Method in class org.apache.rat.documentation.options.AntOption.ExampleGenerator: Creates a string comprising the child elements for the Ant XML report call.
getCollection() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Gets the phrase "or more " if the enclosed matcher may be multiple.
getComment(boolean) - Method in class org.apache.rat.documentation.options.AntOption: Get the method comment for this option.
getDefaultValue() - Method in class org.apache.rat.documentation.options.AbstractOption: Return default value.
getDefaultValue() - Method in class org.apache.rat.documentation.options.MavenOption
getDeprecated() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the deprecated string if the option is deprecated, or an empty string otherwise.
getDescription() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the description in implementation specific format.
getDescription() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the description of the attribute or an empty string.
getDescription() - Method in class org.apache.rat.documentation.velocity.Matcher: Gets the description of the matcher type.
getEnclosed() - Method in class org.apache.rat.documentation.velocity.Matcher: If the matcher encloses another matcher return the definition of that enclosure.
getEnclosed() - Method in class org.apache.rat.documentation.velocity.MatcherTree.Node: Gets the enclosed node only if it is another matcher.
getExample() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets an example of how to use this option in the native UI.
getExample() - Method in class org.apache.rat.documentation.options.AntOption
getExample() - Method in class org.apache.rat.documentation.options.CLIOption
getExample() - Method in class org.apache.rat.documentation.options.MavenOption
getExample(String, Map<String, String>, List<String>) - Method in class org.apache.rat.documentation.options.AntOption.ExampleGenerator: Gets an example Ant XML report call using ant option with the specified attributes and child elements.
getExampleAttributes(String, Map<String, String>) - Method in class org.apache.rat.documentation.options.AntOption.ExampleGenerator: Creates a string comprising the attributes for the Ant XML report call.
getFilteredOptions() - Static method in class org.apache.rat.documentation.options.AntOption: Gets the set of options that are not supported by Ant either by not being supported or by being converted to another argument.
getFilteredOptions() - Static method in class org.apache.rat.documentation.options.MavenOption: Gets the set of options that are not supported by Maven.
getInputStream() - Method in class org.apache.rat.tools.xsd.XsdGenerator: Create an input stream from the output of the generator.
getMatcher() - Method in class org.apache.rat.documentation.velocity.License: Gets the matcher associated with this license.
getMatcherTree() - Method in class org.apache.rat.documentation.velocity.License: Gets the matcher tree associated with this license.
getMavenOptions() - Static method in class org.apache.rat.documentation.options.MavenOption
getMethodFormat(AntOption) - Method in class org.apache.rat.tools.AntGenerator.GenerateType
getMethodSignature(String, boolean) - Method in class org.apache.rat.documentation.options.MavenOption
getName() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the implementation specific name for the CLI option.
getName() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the attribute name.
getName() - Method in class org.apache.rat.documentation.velocity.Matcher: Get the name of the matcher type.
getOption() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the option this abstract option is wrapping.
getPattern(AntOption, AntOption) - Method in class org.apache.rat.tools.AntGenerator.GenerateType
getPropertyAnnotation(String) - Method in class org.apache.rat.documentation.options.MavenOption
getRenameMap() - Static method in class org.apache.rat.documentation.options.AntOption
getRenameMap() - Static method in class org.apache.rat.documentation.options.MavenOption
getRequired() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the required flag.
getRequired() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Gets the required flag.
getRoot() - Method in class org.apache.rat.documentation.velocity.MatcherTree: Gets the description of the root of the tree.
getText() - Method in class org.apache.rat.documentation.options.AbstractOption: return a string showing long and short options if they are available.
getText() - Method in class org.apache.rat.documentation.options.AntOption
getText() - Method in class org.apache.rat.documentation.options.CLIOption
getText() - Method in class org.apache.rat.documentation.options.MavenOption
getType() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the simple class name for the data type for this option.
getType() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Get the type of the attribute.
getType() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Get the type of the enclosed matcher.
getUnsupportedOptions() - Static method in class org.apache.rat.documentation.options.AntOption: Gets the list of unsupported options.
getValue() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the value of the enclosed matcher.
getValue() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Gets the value of the enclosed matcher.

H

hasArg() - Method in class org.apache.rat.documentation.options.AbstractOption: Determine if the enclosed option expects an argument.
hasArgs() - Method in class org.apache.rat.documentation.options.AbstractOption: Returns true if the option has multiple arguments.

I

id() - Method in class org.apache.rat.documentation.velocity.License: Gets the id for this license if it is not a system generated one.
init() - Method in class org.apache.rat.tools.xsd.XsdWriter: Initializes the writer.
innerClass - Variable in class org.apache.rat.tools.AntGenerator.GenerateType: the inner class name text
isAttribute() - Method in class org.apache.rat.documentation.options.AntOption: Returns true if the option should be an attribute of the <rat:report> element.
isDeprecated() - Method in class org.apache.rat.documentation.options.AbstractOption: Determines if the option is deprecated.
isElement() - Method in class org.apache.rat.documentation.options.AntOption: Returns true if the option should be a child element of the <rat:report> element.
isRequired() - Method in class org.apache.rat.documentation.options.AbstractOption: Determines if the option is required.

K

keyValue() - Method in class org.apache.rat.documentation.options.AbstractOption: The key value for the option.

L

level() - Method in class org.apache.rat.documentation.velocity.MatcherTree.Node: Gets the level in the tree of this node.
License - Class in org.apache.rat.documentation.velocity: The License representation for documentation.
licenseProperties() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a list of license property descriptions.
licenses() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of defined licenses.

M

main(String[]) - Static method in class org.apache.rat.documentation.Exporter: Executes the generation of documentation from a configuration definition.
main(String[]) - Static method in class org.apache.rat.tools.AntDocumentation: Creates apt documentation files for Ant.
main(String[]) - Static method in class org.apache.rat.tools.AntGenerator: Creates a base class for an Ant task.
main(String[]) - Static method in class org.apache.rat.tools.ArgumentTypes
main(String[]) - Static method in class org.apache.rat.tools.Documentation: Creates the documentation.
main(String[]) - Static method in class org.apache.rat.tools.MavenGenerator: Creates the Maven MojoClass Requires 3 arguments: the package name for the class the simple class name the directory in which to write the class file.
main(String[]) - Static method in class org.apache.rat.tools.Naming: Creates the CSV file.
main(String[]) - Static method in class org.apache.rat.tools.xsd.XsdGenerator: Command line that accepts standard RAT CLI command line options and generates an XSD from the configuration.
markdownEscape(String) - Method in class org.apache.rat.documentation.velocity.RatTool: Escapes a string for markdown.
Matcher - Class in org.apache.rat.documentation.velocity: The Matcher representation for documentation.
Matcher.Attribute - Class in org.apache.rat.documentation.velocity: The definition of an attribute.
Matcher.Enclosed - Class in org.apache.rat.documentation.velocity: The description of an enclosed matcher.
matchers() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the set of Matchers.
MatcherTree - Class in org.apache.rat.documentation.velocity: The representation of the Matcher tree found in a License.
MatcherTree(IHeaderMatcher) - Constructor for class org.apache.rat.documentation.velocity.MatcherTree: Constructor.
MatcherTree.Node - Class in org.apache.rat.documentation.velocity: The representation of a node in a License Matcher tree.
MavenGenerator - Class in org.apache.rat.tools: A simple tool to convert CLI options to a Maven Mojo base class.
MavenOption - Class in org.apache.rat.documentation.options: A representation of a CLI option as a Maven option
MavenOption(Option) - Constructor for class org.apache.rat.documentation.options.MavenOption: Constructor.
mvnOptions() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a map client option name to Maven Option.

N

name - Variable in class org.apache.rat.documentation.options.AbstractOption: The name for the option
name() - Method in class org.apache.rat.documentation.velocity.License: Gets the name of this license.
Naming - Class in org.apache.rat.tools: A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.
note() - Method in class org.apache.rat.documentation.velocity.License: Gets the space normalized note for the license.

O

open(XsdWriter.Type, String...) - Method in class org.apache.rat.tools.xsd.XsdWriter: Opens (Starts) an element of the specified type along with its attributes.
option - Variable in class org.apache.rat.documentation.options.AbstractOption: The actual UI-specific name for the option
options() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of command line options.
org.apache.rat.documentation - package org.apache.rat.documentation: Contains tools for generating documentation.
org.apache.rat.documentation.options - package org.apache.rat.documentation.options: Contains ancillary enhanced options for the various RAT interfaces.
org.apache.rat.documentation.velocity - package org.apache.rat.documentation.velocity: Contains velocity based tools and accessories.
org.apache.rat.tools - package org.apache.rat.tools: Contains ancillary tools for the RAT program including code generators and name harmonization code.
org.apache.rat.tools.xsd - package org.apache.rat.tools.xsd: Contains XSD file generation tools.

P

pad(int) - Method in class org.apache.rat.documentation.velocity.RatTool: Creates a string of spaces of the specified length.
PATTERN - Static variable in class org.apache.rat.documentation.options.AbstractOption: The pattern to match CLI options in text

R

RatTool - Class in org.apache.rat.documentation.velocity: The Velocity RAT plugin that provides access to the RAT data.
RatTool() - Constructor for class org.apache.rat.documentation.velocity.RatTool: Constructor.

S

SEQUENCE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A sequence
SIMPLE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A simple type
standardCollections() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of standard collections.
stringUtils() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the StringUtils object in order to work with it in Velocity templates.
styleSheets() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of stylesheets.

T

tab() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a tab character.
toString() - Method in class org.apache.rat.documentation.Exporter
traverse() - Method in class org.apache.rat.documentation.velocity.MatcherTree: Executes an in-order-traversal of the tree.

V

valueOf(String) - Static method in enum org.apache.rat.tools.xsd.XsdWriter.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.rat.tools.xsd.XsdWriter.Type: Returns an array containing the constants of this enum type, in the order they are declared.

W

write(Writer) - Method in class org.apache.rat.tools.xsd.XsdGenerator: Writes the XSD to the output.
writeAttributes(List<AntOption>) - Method in class org.apache.rat.tools.AntDocumentation
writeElements(List<AntOption>) - Method in class org.apache.rat.tools.AntDocumentation

X

XsdGenerator - Class in org.apache.rat.tools.xsd: Generates the XSD for a configuration.
XsdGenerator() - Constructor for class org.apache.rat.tools.xsd.XsdGenerator
XsdWriter - Class in org.apache.rat.tools.xsd: A writer that writes XSD nodes.
XsdWriter(Writer) - Constructor for class org.apache.rat.tools.xsd.XsdWriter: Creates an XSD writer that wraps a standard Writer.
XsdWriter.Type - Enum in org.apache.rat.tools.xsd: Types of elements in the XSD

A C D E F G H I K L M N O P R S T V W X
All Classes|All Packages