Index

A C E F G I O R S T V X
All Classes and Interfaces|All Packages

A

asString(ArrayList<String>) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Return lines joined with line separators as a String.

C

Citation - Class in org.forgerock.maven.plugins.xcite

A citation references part of a text file to quote.

Citation(String) - Constructor for class org.forgerock.maven.plugins.xcite.Citation

Construct a citation from a path alone.

Citation(String, char, String) - Constructor for class org.forgerock.maven.plugins.xcite.Citation

Construct a citation from a path, delimiter, and start marker, when the start marker and the end marker are the same.

Citation(String, char, String, String) - Constructor for class org.forgerock.maven.plugins.xcite.Citation

Construct a citation from a path, delimiter, start marker, and end marker.

E

escapeXml(String) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Escape a quote string to be safely included in an XML document.

escapeXml(ArrayList<String>) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Escape an array of quote strings, for safe inclusion in an XML document.

execute() - Method in class org.forgerock.maven.plugins.xcite.XCiteMojo

Replace citations with quotes in included files, writing the resulting files in the output directory.

extractQuote(ArrayList<String>, String) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Extract a single quote from an array of strings.

extractQuote(ArrayList<String>, String, String) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Extract a single quote from an array of strings.

F

FileUtils - Class in org.forgerock.maven.plugins.xcite.utils

Utility methods for handling files.

G

getDelimiter() - Method in class org.forgerock.maven.plugins.xcite.Citation

Returns the value of the delimiter.

getEnd() - Method in class org.forgerock.maven.plugins.xcite.Citation

Returns the value of the start marker, which can be empty.

getIncludedFiles(File, String[], String[]) - Static method in class org.forgerock.maven.plugins.xcite.utils.FileUtils

Get a list of relative file paths based on inclusion patterns.

getPath() - Method in class org.forgerock.maven.plugins.xcite.Citation

Returns the value of the path.

getStart() - Method in class org.forgerock.maven.plugins.xcite.Citation

Returns the value of the start marker, which can be empty.

getStrings(File) - Static method in class org.forgerock.maven.plugins.xcite.utils.FileUtils

Get the content of a file as an array of Strings.

I

indent(ArrayList<String>, String) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Indent an array of strings.

O

org.forgerock.maven.plugins.xcite - package org.forgerock.maven.plugins.xcite

Maven plugin for citing text from any text-based file.

org.forgerock.maven.plugins.xcite.utils - package org.forgerock.maven.plugins.xcite.utils

Utility classes for citing text from any text-based file.

outdent(ArrayList<String>) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Outdent an array of strings, removing an equal number of leftmost spaces from each string until at least one string starts with a non-space character.

R

removeEmptySpace(String) - Static method in class org.forgerock.maven.plugins.xcite.utils.StringUtils

Return an empty string if the string is only whitespace.

Resolver - Class in org.forgerock.maven.plugins.xcite

Resolve citation strings in target files into quotes from source files.

S

setDelimiter(char) - Method in class org.forgerock.maven.plugins.xcite.Citation

Sets the value of the delimiter.

setEnd(String) - Method in class org.forgerock.maven.plugins.xcite.Citation

Sets the value of the end marker, which must not contain the delimiter.

setPath(String) - Method in class org.forgerock.maven.plugins.xcite.Citation

Sets the pathname string for the file to quote.

setStart(String) - Method in class org.forgerock.maven.plugins.xcite.Citation

Sets the value of the start marker, which must not contain the delimiter.

StringUtils - Class in org.forgerock.maven.plugins.xcite.utils

Utility methods for handling strings.

T

toString() - Method in class org.forgerock.maven.plugins.xcite.Citation

Returns the string representation of this citation.

V

valueOf(String) - Static method in class org.forgerock.maven.plugins.xcite.Citation

Returns a Citation from the string representation, assuming the default delimiter, :.

valueOf(String, String) - Static method in class org.forgerock.maven.plugins.xcite.Citation

Returns a Citation from the string representation.

X

XCiteMojo - Class in org.forgerock.maven.plugins.xcite

Copy quotes from source text files into target text files.

XCiteMojo() - Constructor for class org.forgerock.maven.plugins.xcite.XCiteMojo

A C E F G I O R S T V X
All Classes and Interfaces|All Packages