Index

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

A

AbstractJxrReport - Class in org.apache.maven.plugin.jxr: Base class for the JXR reports.
AbstractJxrReport() - Constructor for class org.apache.maven.plugin.jxr.AbstractJxrReport
addClassType(ClassType) - Method in class org.apache.maven.jxr.pacman.JavaFile: Add a class type to the current list of class types.
addClassType(ClassType) - Method in class org.apache.maven.jxr.pacman.PackageType: Adds a class to this package.
addDefaultExcludes() - Method in class org.apache.maven.jxr.ant.DirectoryScanner
addFile(JavaFile) - Method in class org.apache.maven.jxr.pacman.FileManager: Add a file to this file manager.
addImportType(ImportType) - Method in class org.apache.maven.jxr.pacman.JavaFile: Add an import type.
addPackageType(PackageType) - Method in class org.apache.maven.jxr.pacman.PackageManager: Add a package to this package manager.
AggregatorJxrReport - Class in org.apache.maven.plugin.jxr: Generates a combined JXR report in an aggregating project.
AggregatorJxrReport() - Constructor for class org.apache.maven.plugin.jxr.AggregatorJxrReport
AggregatorJxrTestReport - Class in org.apache.maven.plugin.jxr: Generates a combined JXR report for test code in an aggregating project.
AggregatorJxrTestReport() - Constructor for class org.apache.maven.plugin.jxr.AggregatorJxrTestReport
allClasses - Variable in class org.apache.maven.jxr.DirectoryIndexer.ProjectInfo
allPackages - Variable in class org.apache.maven.jxr.DirectoryIndexer.ProjectInfo
append(StringBuilder, String, int) - Method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: Append a description to the buffer by respecting the indentSize and lineLength parameters.
appendFooter(PrintWriter, String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Gets the footer attribute of the JavaCodeTransform object
appendHeader(PrintWriter) - Method in class org.apache.maven.jxr.JavaCodeTransform: Gets the header attribute of the JavaCodeTransform object

B

BaseType - Class in org.apache.maven.jxr.pacman: put your documentation comment here
BaseType(String) - Constructor for class org.apache.maven.jxr.pacman.BaseType: Constructs type and set its name.
beginMultiLineCommentFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Detect and handle the start of multiLine comments.
bottom - Variable in class org.apache.maven.jxr.DirectoryIndexer
bottom - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: String used at the bottom of the Xref HTML files.
BREAKERS - Static variable in class org.apache.maven.jxr.util.SimpleWordTokenizer
build() - Method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo

C

canGenerateReport() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
classes - Variable in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
classes - Variable in class org.apache.maven.jxr.pacman.PackageType
ClassInfo(String, String) - Constructor for class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
ClassType - Class in org.apache.maven.jxr.pacman: Represents a Java class, interface, enum or record.
ClassType(String) - Constructor for class org.apache.maven.jxr.pacman.ClassType: Deprecated.
Please use ClassType( String, String ) instead
ClassType(String, String) - Constructor for class org.apache.maven.jxr.pacman.ClassType: Create a new ClassType.
classTypes - Variable in class org.apache.maven.jxr.pacman.JavaFile
classTypes - Variable in class org.apache.maven.jxr.pacman.JavaFileImpl
COMMENT_END - Static variable in class org.apache.maven.jxr.JavaCodeTransform: end comment delimiter
COMMENT_START - Static variable in class org.apache.maven.jxr.JavaCodeTransform: start comment delimiter
constructSourceDirs() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Gets the list of the source directories to be included in the JXR report generation
copyRequiredResources(String) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Copy some required resources (like the stylesheet) to the given directory
copyResources(String, String, String...) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Copy styles and related resources to the given directory
createXref(Locale, String, List<String>) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Creates the Xref for the Java files found in the given source directory and puts them in the given destination directory.
currentFilename - Variable in class org.apache.maven.jxr.JavaCodeTransform: File name that is currently being processed.

D

DEFAULT_INCLUDES - Static variable in class org.apache.maven.jxr.JXR: The default list of include patterns to use.
DEFAULT_LINE_LENGTH - Static variable in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
defaultPackage - Variable in class org.apache.maven.jxr.pacman.PackageManager: The default Java package.
destDir - Variable in class org.apache.maven.jxr.JXR: Path to destination.
destDir - Variable in class org.apache.maven.plugin.jxr.JxrReport: Directory where the Xref files will be copied to.
destDir - Variable in class org.apache.maven.plugin.jxr.JxrTestReport: Directory where the Xref files will be copied to.
detail - Variable in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: If true, display all settable properties for each goal.
dir - Variable in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
dir - Variable in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
directories - Variable in class org.apache.maven.jxr.pacman.PackageManager
DirectoryIndexer - Class in org.apache.maven.jxr: This class creates the navigational pages for jxr's cross-referenced source files.
DirectoryIndexer(PackageManager, String) - Constructor for class org.apache.maven.jxr.DirectoryIndexer: Constructor for the DirectoryIndexer object
DirectoryIndexer.ClassInfo - Class in org.apache.maven.jxr: Holds class information
DirectoryIndexer.PackageInfo - Class in org.apache.maven.jxr
DirectoryIndexer.ProjectInfo - Class in org.apache.maven.jxr
DirectoryScanner - Class in org.apache.maven.jxr.ant: Workaround to ignore package-info.java files.
DirectoryScanner() - Constructor for class org.apache.maven.jxr.ant.DirectoryScanner
docTitle - Variable in class org.apache.maven.jxr.DirectoryIndexer
docTitle - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Title of main page of the Xref HTML files.
doVelocity(String, String, VelocityContext, VelocityEngine) - Method in class org.apache.maven.jxr.DirectoryIndexer
dump() - Method in class org.apache.maven.jxr.pacman.PackageManager: Dump the package information to STDOUT.

E

encoding - Variable in class org.apache.maven.jxr.pacman.FileManager
encoding - Variable in class org.apache.maven.jxr.pacman.JavaFile
excludes - Variable in class org.apache.maven.jxr.JXR: The list of exclude patterns to use.
excludes - Variable in class org.apache.maven.jxr.pacman.PackageManager: The list of exclude patterns to use.
excludes - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: A list of exclude patterns to use.
execute() - Method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
executeReport(Locale) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport

F

fileManager - Variable in class org.apache.maven.jxr.JavaCodeTransform: current file manager
fileManager - Variable in class org.apache.maven.jxr.pacman.PackageManager
FileManager - Class in org.apache.maven.jxr.pacman: Singleton that handles holding references to JavaFiles.
FileManager() - Constructor for class org.apache.maven.jxr.pacman.FileManager
filename - Variable in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
filename - Variable in class org.apache.maven.jxr.pacman.ClassType: The name of the file that this class resides in, without path or extension.
filename - Variable in class org.apache.maven.jxr.pacman.JavaFile
files - Variable in class org.apache.maven.jxr.pacman.FileManager
findNamedChild(Node, String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
findSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo

G

getAllClasses() - Method in class org.apache.maven.jxr.DirectoryIndexer.ProjectInfo
getAllPackages() - Method in class org.apache.maven.jxr.DirectoryIndexer.ProjectInfo
getBottom() - Method in class org.apache.maven.jxr.DirectoryIndexer: Gets the footer for the navigation pages.
getBottomText() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Returns the bottom text to be displayed at the lower part of the generated JXR reports.
getBundle(Locale) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Returns the correct resource bundle according to the locale.
getClasses() - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
getClassType() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the name of this class.
getClassType(String) - Method in class org.apache.maven.jxr.pacman.PackageType: Given the name of a class, get it from this package or null if it does not exist.
getClassTypes() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the names of the classes in this file.
getClassTypes() - Method in class org.apache.maven.jxr.pacman.PackageType: Gets all the known classes
getCurrentFilename() - Method in class org.apache.maven.jxr.JavaCodeTransform: Gets the current file name.
getDescription(Locale) - Method in class org.apache.maven.plugin.jxr.JxrReport
getDescription(Locale) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getDestinationDirectory() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Abstract method that returns the target directory where the generated JXR reports will be put.
getDestinationDirectory() - Method in class org.apache.maven.plugin.jxr.JxrReport
getDestinationDirectory() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getDir() - Method in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
getDir() - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
getDocTitle() - Method in class org.apache.maven.jxr.DirectoryIndexer: Gets the major page heading.
getEncoding() - Method in class org.apache.maven.jxr.pacman.FileManager: Gets the encoding of source files.
getEncoding() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the encoding attribute.
getFile(Path) - Method in class org.apache.maven.jxr.pacman.FileManager: Gets a file from its name.
If the file does not exist within the FileManager, creates a new one and returns it.
getFilename() - Method in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
getFilename() - Method in class org.apache.maven.jxr.pacman.ClassType: Returns the file name.
getFilename() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the file name without path and extension.
getFilenameWithoutPathOrExtension(Path) - Static method in class org.apache.maven.jxr.pacman.JavaFile: Remove the path and the ".java" extension from a filename.
getFileOverview() - Method in class org.apache.maven.jxr.JavaCodeTransform: Gets an overview header for this file.
getHREF(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Based on the destination package, get the HREF.
getHREF(String, ClassType) - Method in class org.apache.maven.jxr.JavaCodeTransform: Given the current package, get an HREF to the package and class given
getImportTypes() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the imported packages/files that this package has.
getIndentLevel(String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: Gets the indentation level of the specified line.
getIndex() - Method in class org.apache.maven.jxr.util.StringEntry: Gets the index attribute of the StringEntry object.
getJavadocDir() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Abstract method that returns the directory of the javadoc files.
getJavadocDir() - Method in class org.apache.maven.plugin.jxr.JxrReport
getJavadocDir() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getJavadocLocation() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
getLineWidth(int) - Method in class org.apache.maven.jxr.JavaCodeTransform: Handles line width which may need to change depending on which line number you are on.
getMavenJavadocPluginBasicOption(MavenProject, String, String) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil: Returns the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
getMavenJavadocPlugins(MavenProject) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil: Returns the plugin references for the javadoc plugin in a project.
getName() - Method in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
getName() - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
getName() - Method in class org.apache.maven.jxr.pacman.BaseType: Gets the name for this type.
getName(Locale) - Method in class org.apache.maven.plugin.jxr.JxrReport
getName(Locale) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getOutputEncoding() - Method in class org.apache.maven.jxr.DirectoryIndexer: Gets the output encoding.
getOutputName() - Method in class org.apache.maven.plugin.jxr.JxrReport
getOutputName() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getPackage() - Method in class org.apache.maven.jxr.pacman.ImportType: Gets the name of the package that this import is based on: EX: test.* will return "test" EX: test.Test will return "test"
getPackageCount(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Given the name of a package...
getPackageRoot() - Method in class org.apache.maven.jxr.JavaCodeTransform: From the current file, determine the package root based on the current path.
getPackageType() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the package of this class.
getPackageType(String) - Method in class org.apache.maven.jxr.pacman.PackageManager: Given the name of a package (Ex: org.apache.maven.util) obtain it from the package manager.
getPackageTypes() - Method in class org.apache.maven.jxr.pacman.PackageManager: Gets all of the packages in this package manager.
getPath() - Method in class org.apache.maven.jxr.pacman.JavaFile: Gets the path attribute.
getProject() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
getProjectInfo() - Method in class org.apache.maven.jxr.DirectoryIndexer
getPropertyFromExpression(String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
getReader() - Method in class org.apache.maven.jxr.pacman.JavaFileImpl
getReader(Path, String) - Method in class org.apache.maven.jxr.JavaCodeTransform
getRelativeLink(Path, Path) - Static method in class org.apache.maven.jxr.JXR: Creates a relative link from one directory to another.
getRevision() - Method in class org.apache.maven.jxr.JavaCodeTransform: The current revision of the module.
getRootRef() - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
getSession() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Returns the Maven session.
getSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
getSourceRoots() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Abstract method that returns the specified source directories that will be included in the JXR report generation.
getSourceRoots() - Method in class org.apache.maven.plugin.jxr.JxrReport
getSourceRoots() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getSourceRoots(MavenProject) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Abstract method that returns the compile source directories of the specified project that will be included in the JXR report generation
getSourceRoots(MavenProject) - Method in class org.apache.maven.plugin.jxr.JxrReport
getSourceRoots(MavenProject) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
getStart(String) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer: Go through the list of BREAKERS and find the closes one.
getStructure(MavenProject, boolean) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil: Generates the site structure using the project hierarchy (project and its modules) or using the distributionManagement elements from the pom.xml.
getTemplateDir() - Method in class org.apache.maven.jxr.DirectoryIndexer: Gets the template directory.
getTemplateDir() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Determine the templateDir to use, given javadocTemplatesVersion
getTokenizer(Reader) - Method in class org.apache.maven.jxr.pacman.JavaFileImpl: Gets a StreamTokenizer for this file.
getValue(Node, String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
getWindowTitle() - Method in class org.apache.maven.jxr.DirectoryIndexer: Gets the window title.
getWriter(Path, String) - Method in class org.apache.maven.jxr.JavaCodeTransform
goal - Variable in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: The name of the goal for which to show help.

H

hasSources(File) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Checks whether the given directory contains Java files.
HelpMojo - Class in org.apache.maven.plugins.maven_jxr_plugin: Display help information on maven-jxr-plugin.
Call mvn jxr:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
htmlFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Filter html tags into more benign text.

I

importFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Parse out the current link and look for package/import statements and then create HREFs for them
imports - Variable in class org.apache.maven.jxr.pacman.JavaFile
ImportType - Class in org.apache.maven.jxr.pacman: Represents an entry in a java "import" statement
ImportType(String) - Constructor for class org.apache.maven.jxr.pacman.ImportType: Create a new ImportType with the specified name.
includes - Variable in class org.apache.maven.jxr.JXR: The list of include patterns to use.
includes - Variable in class org.apache.maven.jxr.pacman.PackageManager: The list of include patterns to use.
includes - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: A list of include patterns to use.
indentSize - Variable in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: The number of spaces per indentation level, should be positive.
index - Variable in class org.apache.maven.jxr.util.StringEntry
INDEX - Static variable in class org.apache.maven.jxr.DirectoryIndexer
init() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Initialize some attributes required during the report generation
inJavadocComment - Variable in class org.apache.maven.jxr.JavaCodeTransform: Flag set to true when a javadoc comment is started.
inlineCommentFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Filter inline comments from a line and formats them properly.
inMultiLineComment - Variable in class org.apache.maven.jxr.JavaCodeTransform: Flag set to true when a multi-line comment is started.
inputEncoding - Variable in class org.apache.maven.jxr.JXR
isAggregate() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Is the current report aggregated?
isAggregate() - Method in class org.apache.maven.plugin.jxr.AggregatorJxrReport
isAggregate() - Method in class org.apache.maven.plugin.jxr.AggregatorJxrTestReport
isBreaker(char) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer: Return true if the given char is considered a breaker.
isclass - Variable in class org.apache.maven.jxr.pacman.ImportType
isClass() - Method in class org.apache.maven.jxr.pacman.ImportType: Determines whether this is a class import.
isExternalReport() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
isHtmlFile(String) - Static method in class org.apache.maven.jxr.JXR: Checks to see if the file is an HTML file.
isInsideString(String, int) - Method in class org.apache.maven.jxr.JavaCodeTransform: Checks to see if some position in a line is between String start and ending characters.
isInvalidURICharacter(char) - Method in class org.apache.maven.jxr.JavaCodeTransform: if the given char is not one of the following in VALID_URI_CHARS then return true
isJavadocAggregated(MavenProject) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil: Determine if javadoc is aggregated in this project, paying attention to both TODO: take cognizance of javadoc versus test-javadoc the old parameter and the new mojo.
isJavaFile(String) - Static method in class org.apache.maven.jxr.JXR: Check to see if the file is a Java source file.
isNotEmpty(String) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
ispackage - Variable in class org.apache.maven.jxr.pacman.ImportType
isPackage() - Method in class org.apache.maven.jxr.pacman.ImportType: Determines whether this is a package import.
isReportPluginJavaDocPlugin(String, ReportPlugin) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil
isReportPluginMavenJavadoc(String, Plugin) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil

J

JavaCodeTransform - Class in org.apache.maven.jxr: Syntax highlights java by turning it into html.
JavaCodeTransform(PackageManager, FileManager) - Constructor for class org.apache.maven.jxr.JavaCodeTransform
JAVADOC_COMMENT_END - Static variable in class org.apache.maven.jxr.JavaCodeTransform: end javadoc comment delimiter
JAVADOC_COMMENT_START - Static variable in class org.apache.maven.jxr.JavaCodeTransform: start javadoc comment delimiter
javadocDir - Variable in class org.apache.maven.plugin.jxr.JxrReport: Directory where Javadoc is generated for this project.
javadocLinkDir - Variable in class org.apache.maven.jxr.JavaCodeTransform: Relative path to javadocs, suitable for hyperlinking.
javadocLinkDir - Variable in class org.apache.maven.jxr.JXR: Relative path to javadocs, suitable for hyperlinking.
javadocTemplatesVersion - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Version of the Javadoc templates to use.
javadocVersion - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Version of the Javadoc templates to use.
JavaFile - Class in org.apache.maven.jxr.pacman: Interface for objects which wish to provide meta-info about a JavaFile.
JavaFile(Path, String) - Constructor for class org.apache.maven.jxr.pacman.JavaFile
JavaFileImpl - Class in org.apache.maven.jxr.pacman: PacMan implementation of a JavaFile.
JavaFileImpl(Path, String) - Constructor for class org.apache.maven.jxr.pacman.JavaFileImpl: Constructor of a new object that points to a given file.
JXR - Class in org.apache.maven.jxr: Main entry point into Maven used to kick off the XReference code building.
JXR(PackageManager, JavaCodeTransform) - Constructor for class org.apache.maven.jxr.JXR
JxrException - Exception in org.apache.maven.jxr: Exception occurring in JXR.
JxrException(String, Exception) - Constructor for exception org.apache.maven.jxr.JxrException
jxrFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Handles finding classes based on the current filename and then makes HREFs for you to link to them with.
JxrNoForkReport - Class in org.apache.maven.plugin.jxr: Creates an html-based, cross referenced version of Java source code for a project without forking.
JxrNoForkReport() - Constructor for class org.apache.maven.plugin.jxr.JxrNoForkReport
JxrReport - Class in org.apache.maven.plugin.jxr: Creates an html-based, cross referenced version of Java source code for a project.
JxrReport() - Constructor for class org.apache.maven.plugin.jxr.JxrReport
JxrReportUtil - Class in org.apache.maven.plugin.jxr: Utility class for the jxr report.
JxrReportUtil() - Constructor for class org.apache.maven.plugin.jxr.JxrReportUtil
JxrTestNoForkReport - Class in org.apache.maven.plugin.jxr: Creates an html-based, cross referenced version of Java source code for a project's test sources without forking.
JxrTestNoForkReport() - Constructor for class org.apache.maven.plugin.jxr.JxrTestNoForkReport
JxrTestReport - Class in org.apache.maven.plugin.jxr: Creates an html-based, cross referenced version of Java source code for a project's test sources.
JxrTestReport() - Constructor for class org.apache.maven.plugin.jxr.JxrTestReport

K

keywordFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Filters keywords from a line of text and formats them properly.

L

LINE_NUMBERS - Static variable in class org.apache.maven.jxr.JavaCodeTransform: show line numbers
lineLength - Variable in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: The maximum length of a display line, should be positive.
linkJavadoc - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Link the Javadoc from the Source XRef.
locale - Variable in class org.apache.maven.jxr.JavaCodeTransform: The wanted locale
locale - Variable in class org.apache.maven.jxr.JXR
LOGGER - Static variable in class org.apache.maven.jxr.JXR
LOGGER - Static variable in class org.apache.maven.jxr.pacman.PackageManager

M

MAVEN_JAVADOC_PLUGIN_ARTIFACT_ID - Static variable in class org.apache.maven.plugin.jxr.JxrReportUtil
MAVEN_JAVADOC_PLUGIN_GROUP_ID - Static variable in class org.apache.maven.plugin.jxr.JxrReportUtil

N

name - Variable in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
name - Variable in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
name - Variable in class org.apache.maven.jxr.pacman.BaseType
NONBREAKERS - Static variable in class org.apache.maven.jxr.util.SimpleWordTokenizer

O

ongoingMultiLineCommentFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Handle ongoing multi-line comments, detecting ends if present.
State is maintained in private boolean members, one each for javadoc and (normal) multi-line comments.
org.apache.maven.jxr - package org.apache.maven.jxr
org.apache.maven.jxr.ant - package org.apache.maven.jxr.ant
org.apache.maven.jxr.pacman - package org.apache.maven.jxr.pacman
org.apache.maven.jxr.util - package org.apache.maven.jxr.util
org.apache.maven.plugin.jxr - package org.apache.maven.plugin.jxr
org.apache.maven.plugins.maven_jxr_plugin - package org.apache.maven.plugins.maven_jxr_plugin
outputEncoding - Variable in class org.apache.maven.jxr.DirectoryIndexer
outputEncoding - Variable in class org.apache.maven.jxr.JavaCodeTransform: The output encoding
outputEncoding - Variable in class org.apache.maven.jxr.JXR

P

PackageInfo(String, String) - Constructor for class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
packageManager - Variable in class org.apache.maven.jxr.DirectoryIndexer
packageManager - Variable in class org.apache.maven.jxr.JavaCodeTransform: Package Manager for this project.
PackageManager - Class in org.apache.maven.jxr.pacman: Given a list of directories, parse them out and store them as rendered packages, classes, imports, etc.
PackageManager(FileManager) - Constructor for class org.apache.maven.jxr.pacman.PackageManager
packagename - Variable in class org.apache.maven.jxr.pacman.ImportType
packages - Variable in class org.apache.maven.jxr.pacman.PackageManager: All the packages that have been parsed
packageType - Variable in class org.apache.maven.jxr.pacman.JavaFile
PackageType - Class in org.apache.maven.jxr.pacman: Represents a Java package and its subclasses.
PackageType() - Constructor for class org.apache.maven.jxr.pacman.PackageType: Creates a Java package with no name IE the default Java package.
PackageType(String) - Constructor for class org.apache.maven.jxr.pacman.PackageType: Creates a Java package.
parse() - Method in class org.apache.maven.jxr.pacman.JavaFileImpl: Opens up the file and try to determine package, class and import statements.
parse(Path) - Method in class org.apache.maven.jxr.pacman.PackageManager: Parse out all the directories on which this depends.
parseRecursive(String, StreamTokenizer) - Method in class org.apache.maven.jxr.pacman.JavaFileImpl
path - Variable in class org.apache.maven.jxr.pacman.JavaFile
pkgmgr - Variable in class org.apache.maven.jxr.JXR
PLUGIN_HELP_PATH - Static variable in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
process() - Method in class org.apache.maven.jxr.DirectoryIndexer: Does the actual indexing.
process(Path) - Method in class org.apache.maven.jxr.pacman.PackageManager
processPath(PackageManager, Path, String) - Method in class org.apache.maven.jxr.JXR: Now that we have instantiated everything.
ProjectInfo(Map<String, DirectoryIndexer.PackageInfo>, Map<String, DirectoryIndexer.ClassInfo>) - Constructor for class org.apache.maven.jxr.DirectoryIndexer.ProjectInfo
pruneSourceDirs(List<String>) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Compiles the list of directories which contain source files that will be included in the JXR report generation.

R

reactorProjects - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: The projects in the reactor for aggregation report.
readObject(ObjectInputStream) - Method in class org.apache.maven.jxr.JavaCodeTransform
repeat(String, int) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: Repeat a String n times to form a new string.
RESERVED_WORD_END - Static variable in class org.apache.maven.jxr.JavaCodeTransform: end reserved word delimiter
RESERVED_WORD_START - Static variable in class org.apache.maven.jxr.JavaCodeTransform: start reserved word delimiter
reservedWords - Variable in class org.apache.maven.jxr.JavaCodeTransform: HashTable containing java reserved words
revision - Variable in class org.apache.maven.jxr.JavaCodeTransform: Revision of the currently transformed document.
revision - Variable in class org.apache.maven.jxr.JXR: The revision of the module currently being processed.
root - Variable in class org.apache.maven.jxr.DirectoryIndexer
rootRef - Variable in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo

S

session - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport
setBottom(String) - Method in class org.apache.maven.jxr.DirectoryIndexer: Bottom is a footer for the navigation pages, usually a copyright.
See the javadoc documentation for the property of the same name.
setClasses(Map<String, DirectoryIndexer.ClassInfo>) - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
setClassType(ClassType) - Method in class org.apache.maven.jxr.pacman.JavaFile: Sets the name of this class.
setCurrentFilename(Path) - Method in class org.apache.maven.jxr.JavaCodeTransform: Sets the current file name.
setDest(Path) - Method in class org.apache.maven.jxr.JXR: Sets the destination.
setDocTitle(String) - Method in class org.apache.maven.jxr.DirectoryIndexer: docTitle is used as a page heading for the summary files.
See the javadoc documentation for the property of the same name
setEncoding(String) - Method in class org.apache.maven.jxr.pacman.FileManager: Sets the encoding of source files.
setExcludes(String[]) - Method in class org.apache.maven.jxr.JXR
setExcludes(String[]) - Method in class org.apache.maven.jxr.pacman.PackageManager
setFilename(String) - Method in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo
setFilename(String) - Method in class org.apache.maven.jxr.pacman.ClassType: Sets the file name.
setIncludes(String[]) - Method in class org.apache.maven.jxr.JXR
setIncludes(String[]) - Method in class org.apache.maven.jxr.pacman.PackageManager
setInputEncoding(String) - Method in class org.apache.maven.jxr.JXR: Sets the input encoding.
setJavadocLinkDir(Path) - Method in class org.apache.maven.jxr.JXR: Sets the relative path to javadocs.
setJavadocTemplatesVersion() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport: Sets a new value for javadocTemplatesVersion.
setLocale(Locale) - Method in class org.apache.maven.jxr.JXR: Sets the locale.
setOutputEncoding(String) - Method in class org.apache.maven.jxr.DirectoryIndexer: OutputEncoding is the encoding of output files.
setOutputEncoding(String) - Method in class org.apache.maven.jxr.JXR: Sets the output encoding.
setPackageType(PackageType) - Method in class org.apache.maven.jxr.pacman.JavaFile: Sets the package type of this class.
setProperties(VelocityEngine) - Method in class org.apache.maven.jxr.DirectoryIndexer
setReportOutputDirectory(File) - Method in class org.apache.maven.plugin.jxr.JxrReport
setReportOutputDirectory(File) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
setRevision(String) - Method in class org.apache.maven.jxr.JXR: Sets the revision.
setRootRef(String) - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo
setTemplateDir(String) - Method in class org.apache.maven.jxr.DirectoryIndexer: templateDir is the location of the jelly template files used to generate the navigation pages.
setWindowTitle(String) - Method in class org.apache.maven.jxr.DirectoryIndexer: windowTitle is used in the output's <title> tags see the javadoc documentation for the property of the same name
SimpleWordTokenizer - Class in org.apache.maven.jxr.util: This is a small and fast word tokenizer.
SimpleWordTokenizer() - Constructor for class org.apache.maven.jxr.util.SimpleWordTokenizer
skip - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Whether to skip this execution.
sourceDirs - Variable in class org.apache.maven.plugin.jxr.JxrReport: Source directories of the project.
sourceDirs - Variable in class org.apache.maven.plugin.jxr.JxrTestReport: Test directories of the project.
sourcePath - Variable in class org.apache.maven.plugin.jxr.JxrReport: Specifies the source path where the java files are located.
STRING_END - Static variable in class org.apache.maven.jxr.JavaCodeTransform: end String delimiter
STRING_START - Static variable in class org.apache.maven.jxr.JavaCodeTransform: start String delimiter
StringEntry - Class in org.apache.maven.jxr.util: A StringEntry represents a value found by the tokenizer.
StringEntry(String, int) - Constructor for class org.apache.maven.jxr.util.StringEntry: Constructor.
stringFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Filters strings from a line of text and formats them properly.
stylesheet - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Style sheet used for the Xref HTML files.
STYLESHEET_FILENAME - Static variable in class org.apache.maven.jxr.JavaCodeTransform: stylesheet file name
syntaxHighlight(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Now different method of seeing if at end of input stream, closes inputs stream at end.

T

templateDir - Variable in class org.apache.maven.jxr.DirectoryIndexer
templateDir - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Directory where Velocity templates can be found to generate overviews, frames and summaries.
testJavadocDir - Variable in class org.apache.maven.plugin.jxr.JxrTestReport: Directory where Test Javadoc is generated for this project.
tokenize(String) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer: Breaks the given line into multiple tokens.
tokenize(String, int) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer: Internal impl.
tokenize(String, String) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer: Tokenize the given line but only return those tokens that match the parameter find.
toLines(String, int, int, int) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: Splits the specified text into lines of convenient display length.
toLines(List<String>, String, int, int) - Static method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo: Adds the specified line to the output sequence, performing line wrapping if necessary.
toString() - Method in class org.apache.maven.jxr.pacman.BaseType
toString() - Method in class org.apache.maven.jxr.util.StringEntry
transform(Reader, Writer, Locale, String, Path, String, String) - Method in class org.apache.maven.jxr.JavaCodeTransform: This is the public method for doing all transforms of code.
transform(Path, Path, String) - Method in class org.apache.maven.jxr.JXR: Given a source file transform it into HTML and write it to the destination (dest) file.
transform(Path, Path, Locale, String, String, Path, String, String) - Method in class org.apache.maven.jxr.JavaCodeTransform: This is the public method for doing all transforms of code.
transformer - Variable in class org.apache.maven.jxr.JXR: Handles taking .java files and changing them into html.

U

uriFilter(String) - Method in class org.apache.maven.jxr.JavaCodeTransform: Given a line of text, search for URIs and make href's out of them.

V

VALID_URI_CHARS - Static variable in class org.apache.maven.jxr.JavaCodeTransform: Specify the only characters that are allowed in a URI besides alpha and numeric characters.
VALID_URI_SCHEMES - Static variable in class org.apache.maven.jxr.JavaCodeTransform
value - Variable in class org.apache.maven.jxr.util.StringEntry

W

windowTitle - Variable in class org.apache.maven.jxr.DirectoryIndexer
windowTitle - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport: Title of window of the Xref HTML files.
writeGoal(StringBuilder, String, Element) - Method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
writeObject(ObjectOutputStream) - Method in class org.apache.maven.jxr.JavaCodeTransform
writeParameter(StringBuilder, Node, Node) - Method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo

X

xref(List<String>, String, String, String, String) - Method in class org.apache.maven.jxr.JXR: Performs the cross-referencing.
xrLine(String, String, ClassType) - Method in class org.apache.maven.jxr.JavaCodeTransform: Cross Reference the given line with JXR returning the new content.

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