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

A

AbstractXmlPlugin - Class in au.com.acegi.xmlformat
Common infrastructure for the various plugin goals.
AbstractXmlPlugin() - Constructor for class au.com.acegi.xmlformat.AbstractXmlPlugin
 
afterAllProcessed(boolean) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
Invoked after all files in the project have been processed.
afterAllProcessed(boolean) - Method in class au.com.acegi.xmlformat.XmlCheckPlugin
 
afterAllProcessed(boolean) - Method in class au.com.acegi.xmlformat.XmlFormatPlugin
 
attributeQuoteChar - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Quote character to use when writing attributes.
au.com.acegi.xmlformat - package au.com.acegi.xmlformat
XML Formatter Maven Plugin main package.

B

baseDirectory - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
The base directory of the project.
BlankLinesWriter - Class in au.com.acegi.xmlformat
Subclass of XMLWriter that preserves blank lines in outupt (at most one of them, among two subsequent tags).
BlankLinesWriter(OutputStream, XmlOutputFormat) - Constructor for class au.com.acegi.xmlformat.BlankLinesWriter
 
BlankLinesWriter.NewLinesHandler - Class in au.com.acegi.xmlformat
 
buildFormatter() - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 

C

chars - Variable in enum au.com.acegi.xmlformat.LineEnding
 
CR - au.com.acegi.xmlformat.LineEnding
Use the carriage return character.
CRLF - au.com.acegi.xmlformat.LineEnding
Use the carriage return and new line characters.

D

determineLineSeparator() - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 

E

encoding - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
The encoding format.
excludes - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
A set of file patterns that allow you to exclude certain files/folders from the formatting.
execute() - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
expandEmptyElements - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Whether or not to expand empty elements to <tagName></tagName>.

F

find() - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
finished() - Method in class au.com.acegi.xmlformat.BlankLinesWriter.NewLinesHandler
Marks the end of token streams, allows to emit a last newlines if the last tokens were all newlines.
format(InputStream, OutputStream, XmlOutputFormat) - Static method in class au.com.acegi.xmlformat.FormatUtil
Ingest an input stream, writing formatted XML to the output stream.
formatInPlace(File, XmlOutputFormat) - Static method in class au.com.acegi.xmlformat.FormatUtil
Formats the input file, overwriting the input file with the new content if the formatted content differs.
FormatUtil - Class in au.com.acegi.xmlformat
Utility methods private to the package.
FormatUtil() - Constructor for class au.com.acegi.xmlformat.FormatUtil
 

G

getChars() - Method in enum au.com.acegi.xmlformat.LineEnding
 
getXmlWriter(OutputStream, XmlOutputFormat) - Static method in class au.com.acegi.xmlformat.FormatUtil
 

H

hash(File) - Static method in class au.com.acegi.xmlformat.IOUtil
Returns a CRC32 of the given file.
hash(InputStream) - Static method in class au.com.acegi.xmlformat.IOUtil
Returns a CRC32 of the provided input stream.

I

includes - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
A set of file patterns that dictate which files should be included in the formatting with each file pattern being relative to the base directory.
indentSize - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Indicates the number of spaces to apply when indenting.
initializeExcludes() - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
initializeIncludes() - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
IOUtil - Class in au.com.acegi.xmlformat
Utility methods for dealing with I/O resources.
IOUtil() - Constructor for class au.com.acegi.xmlformat.IOUtil
 
isKeepBlankLines() - Method in class au.com.acegi.xmlformat.XmlOutputFormat
When set to true, preserves at most one blank line between tags, if it was alredy present in the input file.

K

keepBlankLines - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Whether to keep blank lines.
keepBlankLines - Variable in class au.com.acegi.xmlformat.XmlOutputFormat
 

L

LF - au.com.acegi.xmlformat.LineEnding
Use the newline character.
lineEnding - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Sets the line-ending of files after formatting.
LineEnding - Enum in au.com.acegi.xmlformat
Valid line endings for use by AbstractXmlPlugin.lineEnding.
LineEnding() - Constructor for enum au.com.acegi.xmlformat.LineEnding
 
LineEnding(String) - Constructor for enum au.com.acegi.xmlformat.LineEnding
 
lineSeparator - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Deprecated.
Please do not set this value; use AbstractXmlPlugin.lineEnding instead

N

needsFormatting(File, XmlOutputFormat) - Static method in class au.com.acegi.xmlformat.FormatUtil
Only checks if the input file would be modified by the formatter, without overwriting it.
newLineAfterDeclaration - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Whether or not to print new line after the XML declaration.
newLineAfterNTags - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Controls when to output a line.separator every so many tags in case of no lines and total text trimming.
newlines - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
The default new line flag, set to do new lines only as in original document.
newLinesCount - Variable in class au.com.acegi.xmlformat.BlankLinesWriter.NewLinesHandler
 
NewLinesHandler() - Constructor for class au.com.acegi.xmlformat.BlankLinesWriter.NewLinesHandler
 

O

omitEncoding - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Whether or not to output the encoding in the XML declaration.

P

padText - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Pad string-element boundaries with whitespace.
processFile(File, XmlOutputFormat) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
Processes a single file found in the project.
processFile(File, XmlOutputFormat) - Method in class au.com.acegi.xmlformat.XmlCheckPlugin
 
processFile(File, XmlOutputFormat) - Method in class au.com.acegi.xmlformat.XmlFormatPlugin
 
processToken(String, boolean) - Method in class au.com.acegi.xmlformat.BlankLinesWriter.NewLinesHandler
Processes the token, counting the newlines and producing at most one in output.

S

setBaseDirectory(File) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
setExcludes(String...) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
setIncludes(String...) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
setKeepBlankLines(boolean) - Method in class au.com.acegi.xmlformat.XmlOutputFormat
When set to true, preserves at most one blank line between tags, if it was alredy present in the input file.
setSkip(boolean) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
setSkipTargetFolder(boolean) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
setTargetDirectory(File) - Method in class au.com.acegi.xmlformat.AbstractXmlPlugin
 
skip - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Skip XML formatting.
skipTargetFolder - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
In addition to the exclusions, the project build directory (typically target) is always excluded if true.
suppressDeclaration - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Whether or not to suppress the XML declaration.
SYSTEM - au.com.acegi.xmlformat.LineEnding
Use the system default line ending.

T

tabIndent - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Use tabs instead of spaces for indents.
targetDirectory - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
The project target directory.
TMP_FILE_PREFIX - Static variable in class au.com.acegi.xmlformat.FormatUtil
 
trimText - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Should we preserve whitespace or not in text nodes.

V

valueOf(String) - Static method in enum au.com.acegi.xmlformat.LineEnding
Returns the enum constant of this type with the specified name.
values() - Static method in enum au.com.acegi.xmlformat.LineEnding
Returns an array containing the constants of this enum type, in the order they are declared.

W

writeString(String) - Method in class au.com.acegi.xmlformat.BlankLinesWriter
 

X

xhtml - Variable in class au.com.acegi.xmlformat.AbstractXmlPlugin
Whether or not to use XHTML standard.
XmlCheckPlugin - Class in au.com.acegi.xmlformat
Finds the XML files in a project and only check them: no files are changed, but the build will fail if any file does not follow the formatting conventions.
XmlCheckPlugin() - Constructor for class au.com.acegi.xmlformat.XmlCheckPlugin
 
XmlFormatPlugin - Class in au.com.acegi.xmlformat
Finds the XML files in a project and automatically reformats them.
XmlFormatPlugin() - Constructor for class au.com.acegi.xmlformat.XmlFormatPlugin
 
XmlOutputFormat - Class in au.com.acegi.xmlformat
Extended DOM4J configuration.
XmlOutputFormat() - Constructor for class au.com.acegi.xmlformat.XmlOutputFormat
 
A B C D E F G H I K L N O P S T V W X 
All Classes All Packages