Index (Apache Creadur Rat::Tools 0.17-SNAPSHOT API)

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

A

AbstractOption - Class in org.apache.rat.tools
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.tools: A class that wraps the CLI option and provides Ant specific values.
AntOption(Option) - Constructor for class org.apache.rat.tools.AntOption: Constructor.
AntOption.ExampleGenerator - Class in org.apache.rat.tools: An example code generator for this AntOption.
argCount() - Method in class org.apache.rat.tools.AbstractOption: Returns the number of arguments.
argumentType - Variable in class org.apache.rat.tools.AbstractOption: The argument type for this option
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.tools.AbstractOption: Replaces CLI pattern options with Maven pattern options.
cleanupName() - Method in class org.apache.rat.tools.AbstractOption: Gets this option's cleaned up name.
cleanupName(Option) - Method in class org.apache.rat.tools.AbstractOption
cleanupName(Option) - Method in class org.apache.rat.tools.AntOption
cleanupName(Option) - Method in class org.apache.rat.tools.MavenOption
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.tools.AntOption: Gets the set of options that are mapped to this option.

D

Documentation - Class in org.apache.rat.tools: Generates text based documentation for Licenses, LicenceFamilies, and Matchers.

E

ELEMENT - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An element
ExampleGenerator() - Constructor for class org.apache.rat.tools.AntOption.ExampleGenerator: The constructor.
execute() - Method in class org.apache.rat.tools.AntDocumentation
EXTENSION - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An extension

F

finish() - Method in class org.apache.rat.tools.xsd.XsdWriter: Finishes the process.

G

getActualAntOption() - Method in class org.apache.rat.tools.AntOption: If this option is converted to another option return that option otherwise return this option.
getArgName() - Method in class org.apache.rat.tools.AbstractOption: Gets the argument name if there is one.
getArgType() - Method in class org.apache.rat.tools.AbstractOption: Gets the argument type if there is one.
getAttributeFunctionName() - Method in class org.apache.rat.tools.AntOption: Get the signature of the attribute function.
getChildElements(String, List<String>) - Method in class org.apache.rat.tools.AntOption.ExampleGenerator: Creates a string comprising the child elements for the Ant XML report call.
getComment(boolean) - Method in class org.apache.rat.tools.AntOption: Get the method comment for this option.
getDefaultValue() - Method in class org.apache.rat.tools.AbstractOption: Return default value.
getDefaultValue() - Method in class org.apache.rat.tools.MavenOption
getDeprecated() - Method in class org.apache.rat.tools.AbstractOption: Gets the deprecated string if the option is deprecated, or an empty string otherwise.
getDescription() - Method in class org.apache.rat.tools.AbstractOption: Gets the description escaped for XML format.
getExample() - Method in class org.apache.rat.tools.AbstractOption: Gets an example of how to use this option in the native UI.
getExample() - Method in class org.apache.rat.tools.AntOption
getExample() - Method in class org.apache.rat.tools.MavenOption
getExample(String, Map<String, String>, List<String>) - Method in class org.apache.rat.tools.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.tools.AntOption.ExampleGenerator: Creates a string comprising the attributes for the Ant XML report call.
getFilter() - Static method in class org.apache.rat.tools.AntGenerator: Gets the Option predicate that removes unsupported CLI options.
getFilter() - Static method in class org.apache.rat.tools.MavenGenerator: Returns the Option predicate that removes all unsupported Options for the Maven UI.
getFilteredOptions() - Static method in class org.apache.rat.tools.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.tools.MavenOption: Gets the set of options that are not supported by Ant.
getInputStream() - Method in class org.apache.rat.tools.xsd.XsdGenerator: Create an input stream from the output of the generator.
getMethodFormat(AntOption) - Method in class org.apache.rat.tools.AntGenerator.GenerateType
getMethodSignature(String, boolean) - Method in class org.apache.rat.tools.MavenOption
getName() - Method in class org.apache.rat.tools.AbstractOption: Gets the Maven name for the CLI option.
getPattern(AntOption, AntOption) - Method in class org.apache.rat.tools.AntGenerator.GenerateType
getPropertyAnnotation(String) - Method in class org.apache.rat.tools.MavenOption
getType() - Method in class org.apache.rat.tools.AbstractOption: Gets the simple class name for the data type for this option.
getUnsupportedOptions() - Static method in class org.apache.rat.tools.AntOption: Gets the list of unsupported options.

H

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

I

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.tools.AntOption: Returns true if the option should be an attribute of the <rat:report> element.
isDeprecated() - Method in class org.apache.rat.tools.AbstractOption: Determines if the option is deprecated.
isElement() - Method in class org.apache.rat.tools.AntOption: Returns true if the option should be a child element of the <rat:report> element.
isRequired() - Method in class org.apache.rat.tools.AbstractOption: Determines if the option is required.

K

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

M

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.
MavenGenerator - Class in org.apache.rat.tools: A simple tool to convert CLI options to Maven Mojo base class
MavenOption - Class in org.apache.rat.tools: A representation of a CLI option as a Maven option

N

name - Variable in class org.apache.rat.tools.AbstractOption: The Maven name for the option
Naming - Class in org.apache.rat.tools: A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.

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.tools.AbstractOption: The CLI that the Maven option is wrapping
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

PATTERN - Static variable in class org.apache.rat.tools.AbstractOption: The pattern to match CLI options in text

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

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 M N O P S V W X
All Classes and Interfaces|All Packages