A B C D E F G H I J L M N P R S T W

A

AbstractLinkConstructorStrategy - Class in de.smartics.maven.util.report.link

Base implementation of the LinkConstructorStrategy interface.

AbstractLinkConstructorStrategy(LinkConstructorStrategyConfig) - Constructor for class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Default constructor.

addPackagePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Adds the package part of the link.

addPackagePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link.strategy. DirectoryPathLinkConstructorStrategy

Adds the package part of the link.

addPackagePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link.strategy. FilePathLinkConstructorStrategy

Adds the package part of the link.

addPackagePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link.strategy. SingleDocumentLinkConstructorStrategy

Adds the package part of the link.

addPackagePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link.strategy. SurefireLinkConstructorStrategy

Adds the package part of the link.

addQualifiedType(StringBuilder, JavaElementRef) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

addReportId(ReportId) - Method in class de.smartics.maven.util.report. ExternalReportReferences

Adds the report ID to the list of IDs to render report references.

appendBasePathSeparator(StringBuilder) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Appends the separator between the base path and the package part.

appendBasePathSeparator(StringBuilder) - Method in class de.smartics.maven.util.report.link.strategy. SingleDocumentLinkConstructorStrategy

Appends the separator between the base path and the package part.

appendMemberPart(StringBuilder, MethodInfo) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Adds the member part of the link if the configuration requires the member part to be rendered.

appendMemberPart(StringBuilder, MethodInfo) - Method in class de.smartics.maven.util.report.link.strategy. LineNumberDirectoryPathLinkConstructorStrategy

Adds the member part of the link if the configuration requires the member part to be rendered.

appendMemberPart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link.strategy. SingleDocumentLinkConstructorStrategy

Adds the member part of the link if the configuration requires the member part to be rendered.

appendTypePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Adds the type part of the link.

appendTypePart(StringBuilder, String) - Method in class de.smartics.maven.util.report.link.strategy. SingleDocumentLinkConstructorStrategy

Adds the type part of the link.

B

build() - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig.Builder

Creates the congfiguration instance.

C

compare(MavenProject, MavenProject) - Method in class de.smartics.maven.util.project. ProjectComparator

Compares the groupId, then the artifactId, and finally the versions, lexicographically.

config - Variable in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

The configuration of this strategy instance.

configure(Log, String) - Method in class de.smartics.maven.util.log4j. Log4jConfigurator

Configures the log4j logger.

configure(Log, String) - Method in class de.smartics.maven.util. SunLoggerConfigurator

Reads a pre-configured configuration file.

configureLogger(Log, String) - Static method in class de.smartics.maven.util. LoggingUtils

Configures the Java logging system.

constructFilePath(StringBuilder, JavaElementRef) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

constructFilePath(StringBuilder, JavaElementRef) - Method in class de.smartics.maven.util.report.link.strategy. SingleDocumentLinkConstructorStrategy

constructLink(String, JavaElementRef) - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Constructs a path to the specified Java element.

constructLink(String, String, MethodInfo) - Method in class de.smartics.maven.util.report.link. ExternalReport

Constructs a link to the given Java element.

constructLink(JavaElementRef) - Method in class de.smartics.maven.util.report.link. ExternalReport

Constructs a link to the given Java Element.

constructLink(String, JavaElementRef) - Method in interface de.smartics.maven.util.report.link. LinkConstructorStrategy

Constructs a link to the specified Java element.

createExternalReport(ReportId, LinkConstructorStrategy) - Method in interface de.smartics.maven.util.report.link. ExternalReportFactory

Constructs an external report.

createExternalReport(ReportId, LinkConstructorStrategy) - Method in class de.smartics.maven.util.report. MavenExternalReportFactory

Constructs an external report.

D

de.smartics.maven.io - package de.smartics.maven.io

de.smartics.maven.util - package de.smartics.maven.util

de.smartics.maven.util.eclipse - package de.smartics.maven.util.eclipse

de.smartics.maven.util.log4j - package de.smartics.maven.util.log4j

de.smartics.maven.util.project - package de.smartics.maven.util.project

de.smartics.maven.util.report - package de.smartics.maven.util.report

Provides utilities for Maven for generating reports.

de.smartics.maven.util.report.link - package de.smartics.maven.util.report.link

Provides helper classes to render links to external reports.

de.smartics.maven.util.report.link.strategy - package de.smartics.maven.util.report.link.strategy

Provides implementation strategies to create links to external reports.

DefaultMavenContext - Class in de.smartics.maven.util.project

A simple bean to provide information to services that require some sort of Maven infrastructure.

DefaultMavenContext(Log, PlexusContainer, String) - Constructor for class de.smartics.maven.util.project. DefaultMavenContext

Default constructor.

DefaultMavenContext(Log, MavenProjectBuilder, ArtifactRepository, ProfileManager) - Constructor for class de.smartics.maven.util.project. DefaultMavenContext

Constructor that sets the container referenct to null.

DirectoryPathLinkConstructorStrategy - Class in de.smartics.maven.util.report.link.strategy

Constructs a link to a document whose directory path is constructed by the package, whose name is constructed by the type and whose member is optionally referenced within the document.

DirectoryPathLinkConstructorStrategy(LinkConstructorStrategyConfig) - Constructor for class de.smartics.maven.util.report.link.strategy. DirectoryPathLinkConstructorStrategy

Default constructor.

E

EMPTY - Static variable in class de.smartics.maven.util.report. ExternalReportReferences

An empty report reference instance that prohibits adding information.

equals(Object) - Method in class de.smartics.maven.util.report.link. ReportId

Returns true if the given object is semantically equal to the given object, false otherwise.

exists(List<String>) - Static method in class de.smartics.maven.util. PathUtils

Checks if any elements of the list of directory roots exists.

ExternalReport - Class in de.smartics.maven.util.report.link

Helper to construct links from a given report instance to other Maven reports.

ExternalReport(ReportId, String, LinkConstructorStrategy) - Constructor for class de.smartics.maven.util.report.link. ExternalReport

Default constructor.

ExternalReportFactory - Interface in de.smartics.maven.util.report.link

Factory to create external reports.

ExternalReportReferences - Class in de.smartics.maven.util.report

Manages report instances.

ExternalReportReferences(ExternalReportFactory) - Constructor for class de.smartics.maven.util.report. ExternalReportReferences

Default constructor.

F

fetchMavenProjectIds(MavenContext, File, Set<String>, Set<String>, boolean) - Static method in class de.smartics.maven.util.eclipse. WorkspaceUtils

Returns the set of IDs of Maven projects found in the given workspace directory.

fetchMavenProjects(MavenContext, File, Set<String>, Set<String>) - Static method in class de.smartics.maven.util.eclipse. WorkspaceUtils

Returns the set of Maven projects found in the given workspace directory.

fetchMavenProjects(MavenContext, File, Set<String>, Set<String>, boolean) - Static method in class de.smartics.maven.util.eclipse. WorkspaceUtils

Returns the set of Maven projects found in the given workspace directory.

FilePathLinkConstructorStrategy - Class in de.smartics.maven.util.report.link.strategy

Constructs a link to a document whose name is constructed from the package and type and whose member is optionally referenced within the document.

FilePathLinkConstructorStrategy(LinkConstructorStrategyConfig) - Constructor for class de.smartics.maven.util.report.link.strategy. FilePathLinkConstructorStrategy

Default constructor.

G

get(ReportId) - Method in class de.smartics.maven.util.report. ExternalReportReferences

Returns the report with the given ID.

getBasePath() - Method in class de.smartics.maven.util.report.link. ExternalReport

Returns the base path to the report to prefix the constructed link.

getConfig() - Method in class de.smartics.maven.util.report.link. AbstractLinkConstructorStrategy

Returns the configuration of this strategy instance.

getConfig() - Method in interface de.smartics.maven.util.report.link. LinkConstructorStrategy

Returns the configuration of this strategy instance.

getContainer() - Method in class de.smartics.maven.util.project. DefaultMavenContext

Returns a reference to the plexus container.

getContainer() - Method in interface de.smartics.maven.util.project. MavenContext

Returns a reference to the plexus container.

getElementName() - Method in class de.smartics.maven.util.report.link. JavaElementRef

Returns the name of the element.

getExtension() - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig

Returns the extension to the file name to reference to.

getLabel(String) - Method in class de.smartics.maven.util.report. MessageHelper

Returns the label for the given key.

getLabel(String, String) - Method in class de.smartics.maven.util.report. MessageHelper

Returns the label for the given key.

getLabelKey() - Method in class de.smartics.maven.util.report.link. ExternalReport

Returns the key to the label to use as a label for the rendered link.

getLabelKey() - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig

Returns the key to the label to use as a label for the rendered link.

getLocalArtifactRepository() - Method in class de.smartics.maven.util.project. DefaultMavenContext

Returns a reference to the local artifact repository.

getLocalArtifactRepository() - Method in interface de.smartics.maven.util.project. MavenContext

Returns a reference to the local artifact repository.

getLocale() - Method in class de.smartics.maven.util.report. MessageHelper

Returns the locale the message helper provides messages for.

getLog() - Method in class de.smartics.maven.util.project. DefaultMavenContext

Returns the plugin logger.

getLog() - Method in interface de.smartics.maven.util.project. MavenContext

Returns the plugin logger.

getPackageName() - Method in class de.smartics.maven.util.report.link. JavaElementRef

Returns the name of the package.

getProfileManager() - Method in class de.smartics.maven.util.project. DefaultMavenContext

Returns a reference to the profile manager.

getProfileManager() - Method in interface de.smartics.maven.util.project. MavenContext

Returns a reference to the profile manager.

getProjectBuilder() - Method in class de.smartics.maven.util.project. DefaultMavenContext

Returns a reference to the configured project builder.

getProjectBuilder() - Method in interface de.smartics.maven.util.project. MavenContext

Returns a reference to the configured project builder.

getReportArtifactId() - Method in class de.smartics.maven.util.report.link. ReportId

Returns the report artifact ID this strategy is constructed for.

getReportDescriptionId() - Method in class de.smartics.maven.util.report. MessageHelper

Returns the localized report description.

getReportId() - Method in class de.smartics.maven.util.report.link. ExternalReport

Returns the report ID this strategy is constructed for.

getReportIds() - Method in class de.smartics.maven.util.report. ExternalReportReferences

Returns the list of report IDs that are to referenced.

getReportLocation() - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig

Returns the location of the report to link to.

getReports() - Method in class de.smartics.maven.util.report. ExternalReportReferences

Returns the ordered list of report IDs to render.

getReports(List<ReportId>) - Method in class de.smartics.maven.util.report. ExternalReportReferences

Returns the list of reports with the given IDs.

getReportTitleId() - Method in class de.smartics.maven.util.report. MessageHelper

Returns the localized report title.

getReportType() - Method in class de.smartics.maven.util.report.link. ReportId

Returns the type of report generated by the ReportId.getReportArtifactId() to reference.

getSkinArtifactFile(MavenProject, ArtifactRepository, ArtifactResolver, ArtifactFactory) - Static method in class de.smartics.maven.util.report. ReportUtils

Returns a file reference to the default skin useful for rendering standalone run reports.

getString(String) - Static method in class de.smartics.maven.util.eclipse. Messages

Returns the message for the given key.

getString(String, Object[]) - Static method in class de.smartics.maven.util.eclipse. Messages

Returns the message for the given key.

getString(String, Object) - Static method in class de.smartics.maven.util.eclipse. Messages

Convenience method if there is just one parameter.

getString(String, Object, Object) - Static method in class de.smartics.maven.util.eclipse. Messages

Convenience method if there is just two parameters.

getTypeName() - Method in class de.smartics.maven.util.report.link. JavaElementRef

Returns the name of the Java class.

getUpPath(String) - Static method in class de.smartics.maven.util. PathUtils

H

hashCode() - Method in class de.smartics.maven.util.report.link. ReportId

Returns the hash code of the object.

I

isReferenceMember() - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig

Returns the hint to request to construct a strategy specific link part to reference a member.

J

JavaElementRef - Class in de.smartics.maven.util.report.link

A reference to a Java element.

JavaElementRef(String, String, MethodInfo) - Constructor for class de.smartics.maven.util.report.link. JavaElementRef

Default constructor.

L

LineNumberDirectoryPathLinkConstructorStrategy - Class in de.smartics.maven.util.report.link.strategy

A variation that uses the line number and not the member signature to construct the anchor.

LineNumberDirectoryPathLinkConstructorStrategy(LinkConstructorStrategyConfig) - Constructor for class de.smartics.maven.util.report.link.strategy. LineNumberDirectoryPathLinkConstructorStrategy

Default constructor.

LinkConstructorStrategy - Interface in de.smartics.maven.util.report.link

Defines the API to a strategy to handle information to construct a link.

LinkConstructorStrategyConfig - Class in de.smartics.maven.util.report.link

Configuration information for a LinkConstructorStrategy.

LinkConstructorStrategyConfig.Builder - Class in de.smartics.maven.util.report.link

Builds instances of LinkConstructorStrategyConfig.

LinkConstructorStrategyConfig.Builder() - Constructor for class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig.Builder

Log4jConfigurator - Class in de.smartics.maven.util.log4j

Configures the log4j framework with the logging information.

Log4jConfigurator() - Constructor for class de.smartics.maven.util.log4j. Log4jConfigurator

Default constructor.

LoggingUtils - Class in de.smartics.maven.util

Utility class for configuring loggers in Maven.

M

MAVEN_COBERTURA_PLUGIN - Static variable in class de.smartics.maven.util.report. MavenExternalReportFactory

The artifact ID of the cobertura plugin.

MAVEN_JAVADOC_PLUGIN - Static variable in class de.smartics.maven.util.report. MavenExternalReportFactory

The artifact ID of the Javadoc plugin.

MAVEN_JXR_PLUGIN - Static variable in class de.smartics.maven.util.report. MavenExternalReportFactory

The artifact ID of the jxr plugin.

MAVEN_SUREFIRE_PLUGIN - Static variable in class de.smartics.maven.util.report. MavenExternalReportFactory

The artifact ID of the surefire plugin.

MavenContext - Interface in de.smartics.maven.util.project

Simple wrapper arround a plexus container.

MavenExternalReportFactory - Class in de.smartics.maven.util.report

Factory to create external reports within a Maven project.

MavenExternalReportFactory(MavenProject, String) - Constructor for class de.smartics.maven.util.report. MavenExternalReportFactory

Convenience constructor using no logging.

MavenExternalReportFactory(Log, MavenProject, String) - Constructor for class de.smartics.maven.util.report. MavenExternalReportFactory

Default constructor.

MessageHelper - Class in de.smartics.maven.util.report

Helps to fetch labels to render reports.

MessageHelper(String, String, ResourceBundle, ResourceBundle) - Constructor for class de.smartics.maven.util.report. MessageHelper

Default constructor.

Messages - Class in de.smartics.maven.util.eclipse

This is a simple wrapper for the messages of this package.

MojoIoUtils - Class in de.smartics.maven.io

Utilities for Mojos working with IO.

N

NORMAL_REPORT - Static variable in class de.smartics.maven.util.report.link. ReportId

Defines the type for normal reports.

normalizeFileName(String) - Static method in class de.smartics.maven.io. MojoIoUtils

Normalises the file name to be used as a URL name.

P

PathUtils - Class in de.smartics.maven.util

Utilities for handling paths Maven.

ProjectComparator - Class in de.smartics.maven.util.project

A simple implementation of a comparator that compares the groupId, then the artifactId, and finally the versions, lexicographically.

ProjectComparator() - Constructor for class de.smartics.maven.util.project. ProjectComparator

provideDirectory(File) - Static method in class de.smartics.maven.io. MojoIoUtils

Ensures that the given directory is present and if not, creates it.

provideMojoDirectory(String) - Static method in class de.smartics.maven.io. MojoIoUtils

Ensures that the directory with the given name is present and if not, creates it.

provideMojoDirectory(File) - Static method in class de.smartics.maven.io. MojoIoUtils

Ensures that the given directory is present and if not, creates it.

provideReportDirectory(File) - Static method in class de.smartics.maven.io. MojoIoUtils

Ensures that the given directory is present and if not, creates it.

R

registerReport(ReportId, LinkConstructorStrategy) - Method in class de.smartics.maven.util.report. ExternalReportReferences

Registers a report with the given identifier and strategy.

registerReport(boolean, ReportId, LinkConstructorStrategy) - Method in class de.smartics.maven.util.report. ExternalReportReferences

Registers a report with the given identifier and strategy with a guard.

reportId - Variable in class de.smartics.maven.util.report.link. ExternalReport

The report ID this strategy is constructed for.

ReportId - Class in de.smartics.maven.util.report.link

Identifies a specific report of a project to reference to.

ReportId(String, String) - Constructor for class de.smartics.maven.util.report.link. ReportId

Default constructor.

ReportUtils - Class in de.smartics.maven.util.report

Utilities for Maven for generating reports.

S

serialize(Document, OutputStream) - Static method in class de.smartics.maven.io. MojoIoUtils

Writes the DOM document to the given stream.

serialize(Document, OutputStream, boolean) - Static method in class de.smartics.maven.io. MojoIoUtils

Writes the DOM document to the given stream.

setExtension(String) - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig.Builder

Sets the extension to the file name to reference to.

setLabelKey(String) - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig.Builder

Sets the key to the label to use as a label for the rendered link.

setReferenceMember(boolean) - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig.Builder

Sets the hint to request to construct a strategy specific link part to reference a member.

setReportLocation(File) - Method in class de.smartics.maven.util.report.link. LinkConstructorStrategyConfig.Builder

Sets the location of the report to link to.

SingleDocumentLinkConstructorStrategy - Class in de.smartics.maven.util.report.link.strategy

Constructs a link to a document that contains all package, type and member information.

SingleDocumentLinkConstructorStrategy(LinkConstructorStrategyConfig) - Constructor for class de.smartics.maven.util.report.link.strategy. SingleDocumentLinkConstructorStrategy

Default constructor.

SunLoggerConfigurator - Class in de.smartics.maven.util

Configures the log4j framework with the logging information.

SunLoggerConfigurator() - Constructor for class de.smartics.maven.util. SunLoggerConfigurator

Default constructor.

SurefireLinkConstructorStrategy - Class in de.smartics.maven.util.report.link.strategy

A specific implementation for the surefire plugin of the SingleDocumentLinkConstructorStrategy since the report currently shows no dot between the type and the member.

SurefireLinkConstructorStrategy(LinkConstructorStrategyConfig) - Constructor for class de.smartics.maven.util.report.link.strategy. SurefireLinkConstructorStrategy

Default constructor.

T

TEST_REPORT - Static variable in class de.smartics.maven.util.report.link. ReportId

Defines the type for test reports.

toClassPath(List<Artifact>) - Static method in class de.smartics.maven.util. PathUtils

Builds a class path from the list of artifacts.

toClassPathString(List<Artifact>, char) - Static method in class de.smartics.maven.util. PathUtils

Builds a class path string from the list of artifacts.

toString() - Method in class de.smartics.maven.util.report.link. JavaElementRef

Returns the string representation of the object.

toString() - Method in class de.smartics.maven.util.report.link. ReportId

Returns the string representation of the object.

W

WorkspaceUtils - Class in de.smartics.maven.util.eclipse

This utility class provides functions that deal with the eclipse workspace useful for Maven plugins.

A B C D E F G H I J L M N P R S T W