A B C D E F G H I J L O P R S T U V W X 

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 ClassType to the current list of class types.
addClassType(ClassType) - Method in class org.apache.maven.jxr.pacman.PackageType
Add 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 filemanager.
addImportType(ImportType) - Method in class org.apache.maven.jxr.pacman.JavaFile
Add an ImportType to the current imports.
addPackageType(PackageType) - Method in class org.apache.maven.jxr.pacman.PackageManager
Add a package to the PackageManager
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
 
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() - Constructor for class org.apache.maven.jxr.pacman.BaseType
 
BREAKERS - Static variable in class org.apache.maven.jxr.util.SimpleWordTokenizer
Description of the Field

C

canGenerateReport(List<String>) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
canGenerateReport() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
ClassType - Class in org.apache.maven.jxr.pacman
Represents a Java class or interface.
ClassType(String) - Constructor for class org.apache.maven.jxr.pacman.ClassType
Deprecated.
ClassType(String, String) - Constructor for class org.apache.maven.jxr.pacman.ClassType
Create a new ClassType.
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
compareTo(StringEntry) - Method in class org.apache.maven.jxr.util.StringEntry
Compare two objects for equality.
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

D

debug(String) - Method in interface org.apache.maven.jxr.log.Log
 
debug(String) - Method in class org.apache.maven.plugin.jxr.PluginLogAdapter
 
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
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
 
dump() - Method in class org.apache.maven.jxr.pacman.PackageManager
Dump the package information to STDOUT.

E

error(String) - Method in interface org.apache.maven.jxr.log.Log
 
error(String) - Method in class org.apache.maven.plugin.jxr.PluginLogAdapter
 
execute() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
execute() - Method in class org.apache.maven.plugin.jxr.HelpMojo
executeReport(Locale) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 

F

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
 

G

getBottom() - Method in class org.apache.maven.jxr.DirectoryIndexer
see setBottom(String)
getBundle(Locale) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Returns the correct resource bundle according to the locale
getClassType() - Method in class org.apache.maven.jxr.pacman.JavaFile
Get 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
Get the names of the classes in this file.
getClassTypes() - Method in class org.apache.maven.jxr.pacman.PackageType
Get all the known classes
getCurrentFilename() - Method in class org.apache.maven.jxr.JavaCodeTransform
Get the current filename
getDescription(Locale) - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getDescription(Locale) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getDest() - Method in class org.apache.maven.jxr.JXR
Get the path to the destination files.
getDestfile() - Method in class org.apache.maven.jxr.JavaCodeTransform
The current destination file being written
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
 
getDocTitle() - Method in class org.apache.maven.jxr.DirectoryIndexer
see setDocTitle(String)
getEncoding() - Method in class org.apache.maven.jxr.pacman.FileManager
see setEncoding(String)
getEncoding() - Method in class org.apache.maven.jxr.pacman.JavaFile
Gets the encoding attribute of the JavaFile object
getFile(String) - Method in class org.apache.maven.jxr.pacman.FileManager
Get a file from it's name.
getFileManager() - Method in class org.apache.maven.jxr.pacman.PackageManager
 
getFilename() - Method in class org.apache.maven.jxr.pacman.ClassType
 
getFilename() - Method in class org.apache.maven.jxr.pacman.JavaFile
Gets the filename attribute of the JavaFile object
getImportTypes() - Method in class org.apache.maven.jxr.pacman.JavaFile
Get the imported packages/files that this package has.
getIndex() - Method in class org.apache.maven.jxr.util.StringEntry
Gets the index attribute of the StringEntry object
getInstance() - Static method in class org.apache.maven.jxr.pacman.FileManager
Get an instance of the FileManager
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
 
getMavenJavadocPluginBasicOption(MavenProject, String, String) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil
Return 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
Return the plugin references for the javadoc plugin in a project.
getName() - Method in class org.apache.maven.jxr.pacman.BaseType
Get 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
 
getOutputDirectory() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
getOutputEncoding() - Method in class org.apache.maven.jxr.DirectoryIndexer
see setOutputEncoding(String)
getOutputEncoding() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Gets the effective reporting output files 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
Get the name of the package that this import is based on: EX: test.* will return "test" EX: test.Test will return "test"
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
Get 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 PackageManager
getPackageTypes() - Method in class org.apache.maven.jxr.pacman.PackageManager
Get all of the packages in the PackageManager
getProject() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
getRevision() - Method in class org.apache.maven.jxr.JavaCodeTransform
The current revision of the CVS module
getSiteRenderer() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
getSourceDirectory() - Method in class org.apache.maven.jxr.JavaCodeTransform
The current source directory being read from.
getSourcefile() - Method in class org.apache.maven.jxr.JavaCodeTransform
The current source file being read
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(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() - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getSourceRoots(MavenProject) - 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.JxrTestReport
 
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
see setTemplateDir(String)
getWindowTitle() - Method in class org.apache.maven.jxr.DirectoryIndexer
see setWindowTitle(String)

H

HelpMojo - Class in org.apache.maven.plugin.jxr
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.plugin.jxr.HelpMojo
 

I

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
info(String) - Method in interface org.apache.maven.jxr.log.Log
 
info(String) - Method in class org.apache.maven.plugin.jxr.PluginLogAdapter
 
init(RuntimeServices) - Method in class org.apache.maven.jxr.log.VelocityLogger
 
init() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Initialize some attributes required during the report generation
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
 
isClass() - Method in class org.apache.maven.jxr.pacman.ImportType
Return true if 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
Check to see if the file is an HTML file.
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.
isPackage() - Method in class org.apache.maven.jxr.pacman.ImportType
Return true if this is a package import.

J

JavaCodeTransform - Class in org.apache.maven.jxr
Syntax highlights java by turning it into html.
JavaCodeTransform(PackageManager) - Constructor for class org.apache.maven.jxr.JavaCodeTransform
Constructor for the JavaCodeTransform object
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
JavaFile - Class in org.apache.maven.jxr.pacman
Interface for objects which wish to provide meta-info about a JavaFile.
JavaFile() - Constructor for class org.apache.maven.jxr.pacman.JavaFile
 
JavaFileImpl - Class in org.apache.maven.jxr.pacman
PacMan implementation of a JavaFile.
JavaFileImpl(String, String) - Constructor for class org.apache.maven.jxr.pacman.JavaFileImpl
Create a new JavaFileImpl 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() - 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
 
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
 
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
 

L

LINE_NUMBERS - Static variable in class org.apache.maven.jxr.JavaCodeTransform
show line numbers
Log - Interface in org.apache.maven.jxr.log
Logging interface.
logVelocityMessage(int, String) - Method in class org.apache.maven.jxr.log.VelocityLogger
 

O

org.apache.maven.jxr - package org.apache.maven.jxr
 
org.apache.maven.jxr.ant - package org.apache.maven.jxr.ant
 
org.apache.maven.jxr.log - package org.apache.maven.jxr.log
 
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
 

P

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(Log, FileManager) - Constructor for class org.apache.maven.jxr.pacman.PackageManager
 
PackageType - Class in org.apache.maven.jxr.pacman
Represents a Java package and its subclasses.
PackageType(String) - Constructor for class org.apache.maven.jxr.pacman.PackageType
Create a Java package
PackageType() - Constructor for class org.apache.maven.jxr.pacman.PackageType
Create a Java package with no name IE the default Java package.
PluginLogAdapter - Class in org.apache.maven.plugin.jxr
Logging adapter.
PluginLogAdapter(Log) - Constructor for class org.apache.maven.plugin.jxr.PluginLogAdapter
Class constructor
process(Log) - Method in class org.apache.maven.jxr.DirectoryIndexer
Does the actual indexing.
process(String) - Method in class org.apache.maven.jxr.pacman.PackageManager
Description of the Method
process(String[]) - Method in class org.apache.maven.jxr.pacman.PackageManager
Description of the Method
processPath(PackageManager, String, String) - Method in class org.apache.maven.jxr.JXR
Now that we have instantiated everything.
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.
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

S

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
setClassType(ClassType) - Method in class org.apache.maven.jxr.pacman.JavaFile
Set the name of this class.
setCurrentFilename(String) - Method in class org.apache.maven.jxr.JavaCodeTransform
Set the current filename
setDest(String) - Method in class org.apache.maven.jxr.JXR
 
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
Encoding is the encoding of source files.
setEncoding(String) - Method in class org.apache.maven.jxr.pacman.JavaFile
Sets the encoding attribute of the JavaFile object
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.pacman.ClassType
 
setFilename(String) - Method in class org.apache.maven.jxr.pacman.JavaFile
Sets the filename attribute of the JavaFile object
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
 
setJavadocLinkDir(String) - Method in class org.apache.maven.jxr.JXR
 
setLocale(Locale) - Method in class org.apache.maven.jxr.JXR
 
setLog(Log) - Method in class org.apache.maven.jxr.JXR
 
setName(String) - Method in class org.apache.maven.jxr.pacman.BaseType
Set the name for this type
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
 
setPackageType(PackageType) - Method in class org.apache.maven.jxr.pacman.JavaFile
Set the PackageType of this class.
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
 
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.
setTransformer(JavaCodeTransform) - Method in class org.apache.maven.jxr.JXR
 
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.
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 for the StringEntry object
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

tokenize(String) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer
Break the given line into multiple StringUtils
tokenize(String, String) - Static method in class org.apache.maven.jxr.util.SimpleWordTokenizer
Tokenize the given line but only return StringUtils that match the parameter find.
toString() - Method in class org.apache.maven.jxr.util.StringEntry
Description of the Method
transform(Reader, Writer, Locale, String, String, String, String, String) - Method in class org.apache.maven.jxr.JavaCodeTransform
This is the public method for doing all transforms of code.
transform(String, String, Locale, String, String, String, String, String) - Method in class org.apache.maven.jxr.JavaCodeTransform
This is the public method for doing all transforms of code.

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
Description of the Field
VelocityLogger - Class in org.apache.maven.jxr.log
Logging interface for Velocity.
VelocityLogger() - Constructor for class org.apache.maven.jxr.log.VelocityLogger
 

W

warn(String) - Method in interface org.apache.maven.jxr.log.Log
 
warn(String) - Method in class org.apache.maven.plugin.jxr.PluginLogAdapter
 

X

xref(List<String>, String, String, String, String) - Method in class org.apache.maven.jxr.JXR
 
xrLine(String, String, ClassType) - Method in class org.apache.maven.jxr.JavaCodeTransform
Cross Reference the given line with JXR returning the new content.
xrLine(String, String) - Method in class org.apache.maven.jxr.JavaCodeTransform
Highlight the package in this line.
A B C D E F G H I J L O P R S T U V W X 

Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.