A B C D E F G H I J O P R S T 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

B

BaseType - Class in org.apache.maven.jxr.pacman

put your documentation comment here

BaseType() - Constructor for class org.apache.maven.jxr.pacman.BaseType

C

canGenerateReport(List<String>) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport

canGenerateReport() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport

ClassInfo(String, String) - Constructor for class org.apache.maven.jxr.DirectoryIndexer.ClassInfo

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.

Please use ClassType.ClassType( String, String ) instead

ClassType(String, String) - Constructor for class org.apache.maven.jxr.pacman.ClassType

Create a new ClassType.

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

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

dump() - Method in class org.apache.maven.jxr.pacman.PackageManager

Dump the package information to STDOUT.

E

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

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

see setBottom(String)

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

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

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

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(Path) - Method in class org.apache.maven.jxr.pacman.FileManager

Get a file from it's name.

getFilename() - Method in class org.apache.maven.jxr.DirectoryIndexer.ClassInfo

getFilename() - Method in class org.apache.maven.jxr.pacman.ClassType

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

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.DirectoryIndexer.ClassInfo

getName() - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo

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"

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

getPath() - Method in class org.apache.maven.jxr.pacman.JavaFile

Gets the filename attribute of the JavaFile object

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

getRootRef() - Method in class org.apache.maven.jxr.DirectoryIndexer.PackageInfo

getSiteRenderer() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport

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

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, FileManager) - Constructor for class org.apache.maven.jxr.JavaCodeTransform

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

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(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

JxrNoForkReport - Class in org.apache.maven.plugin.jxr

Creates an html-based, cross referenced version of Java source code for a project with 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

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.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

PackageInfo(String, String) - Constructor for class org.apache.maven.jxr.DirectoryIndexer.PackageInfo

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

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.

process() - Method in class org.apache.maven.jxr.DirectoryIndexer

Does the actual indexing.

process(Path) - Method in class org.apache.maven.jxr.pacman.PackageManager

Description of the Method

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.

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

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

Set the name of this class.

setDest(Path) - 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.

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

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(Path) - Method in class org.apache.maven.jxr.JXR

setLocale(Locale) - 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

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.

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

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(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.

X

xref(List<String>, String, String, String, String) - Method in class org.apache.maven.jxr.JXR

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