Index (buildmetadata-maven-plugin 1.5.0 API)

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

A

AbstractBuildMojo - Class in com.redhat.rcm.maven.plugin.buildmetadata: Base implementation for all build mojos.
AbstractBuildMojo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo
AbstractMetaDataProvider - Class in com.redhat.rcm.maven.plugin.buildmetadata.data: Base implementation for MetaDataProviders.
AbstractMetaDataProvider() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider: Default constructor.
AbstractReportMojo - Class in com.redhat.rcm.maven.plugin.buildmetadata: The abstract base implementation for reports.
AbstractReportMojo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo
AdditionalLocationsSupport - Class in com.redhat.rcm.maven.plugin.buildmetadata.io: Helper to copy buildmetadata files to additional locations to be grabbed by secondary packers.
AdditionalLocationsSupport(MavenProject, AdditionalLocationsSupport.Config) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.io.AdditionalLocationsSupport: Default constructor.
AdditionalLocationsSupport.Config - Class in com.redhat.rcm.maven.plugin.buildmetadata.io: Collects the configuration for the plugin.
AdditionalLocationsSupport.Config() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.io.AdditionalLocationsSupport.Config
addToFilters - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo: Flag to indicate whether or not the generated properties file should be added to the projects filters.

B

build(Provider) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MetaDataProviderBuilder: Creates a configured instance of the MetaDataProvider interface.
buildDatePattern - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.BuildMetaDataMojo: The date pattern to use to format the build and revision dates.
BuildMetaDataMojo - Class in com.redhat.rcm.maven.plugin.buildmetadata: Provides the build properties.
BuildMetaDataMojo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.BuildMetaDataMojo
BuildPointMojo - Class in com.redhat.rcm.maven.plugin.buildmetadata: Adds the build time to the properties file and runs all providers flagged with Provider.RUN_AT_BUILD_POINT .
BuildPointMojo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.BuildPointMojo
BuildPropertiesFileHelper - Class in com.redhat.rcm.maven.plugin.buildmetadata.io: Helper to handle the build meta data properties file.
BuildPropertiesFileHelper(Log, File, FilePathNormalizer) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.io.BuildPropertiesFileHelper: Default constructor.
BuildReportMojo - Class in com.redhat.rcm.maven.plugin.buildmetadata: Generates a report about the meta data provided to the build.
BuildReportMojo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo
BuildReportRenderer - Class in com.redhat.rcm.maven.plugin.buildmetadata: Renders the build report.
BuildReportRenderer(FilePathNormalizer, ResourceBundle, Sink, File, List<Property>) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportRenderer: Default constructor.
BuildXmlFileHelper - Class in com.redhat.rcm.maven.plugin.buildmetadata.io: Helper to handle the build meta data properties file.
BuildXmlFileHelper(String, Log, File, List<Property>) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.io.BuildXmlFileHelper: Default constructor.

C

calcNonStandardProperties(Properties, List<Property>) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant: Calculates the non standard properties relevant for the misc section.
canGenerateReport() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo
canGenerateReport() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo
com.redhat.rcm.maven.plugin.buildmetadata - package com.redhat.rcm.maven.plugin.buildmetadata: The core package for calculating build meta data for Maven.
com.redhat.rcm.maven.plugin.buildmetadata.common - package com.redhat.rcm.maven.plugin.buildmetadata.common: Provides commonly used classes of this project.
com.redhat.rcm.maven.plugin.buildmetadata.data - package com.redhat.rcm.maven.plugin.buildmetadata.data: Provides classes that provide meta data.
com.redhat.rcm.maven.plugin.buildmetadata.io - package com.redhat.rcm.maven.plugin.buildmetadata.io: Provides classes that write build meta data to files.
com.redhat.rcm.maven.plugin.buildmetadata.maven - package com.redhat.rcm.maven.plugin.buildmetadata.maven: Provides classes to access Maven.
com.redhat.rcm.maven.plugin.buildmetadata.scm - package com.redhat.rcm.maven.plugin.buildmetadata.scm: Provides implementation independent interfaces and classes to access SCM systems.
com.redhat.rcm.maven.plugin.buildmetadata.scm.maven - package com.redhat.rcm.maven.plugin.buildmetadata.scm.maven: Provides an implementation to access SCM systems based on the Apache Maven SCM implementation.
com.redhat.rcm.maven.plugin.buildmetadata.util - package com.redhat.rcm.maven.plugin.buildmetadata.util: Provides utilities for this plugin.
configure(ScmProviderRepository) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Configures the repository with authentication information.
configure(ScmProviderRepositoryWithHost) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Configures the repository with private key and password information.
configure(SvnScmProviderRepository) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Configures the repository with the tag base information.
configureByServer(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmCredentials: Fetches the server information from the settings for the specified host.
Constant - Class in com.redhat.rcm.maven.plugin.buildmetadata.common: Constants used in this package.
Constant.Section - Class in com.redhat.rcm.maven.plugin.buildmetadata.common: The section allows to group build meta data properties.
containsModifications(ScmFileSet) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenScmRevisionNumberFetcher: Checks if the local source files are in-sync with the repository or not.
containsModifications(ScmFileSet) - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.scm.RevisionNumberFetcher: Checks if the local source files are in-sync with the repository or not.
createException(Log, Throwable, String) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.MojoUtils: Logs and creates the given exception.
createFileSet() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo: Creates the file set on the root directory of the checked out project.
createManifest(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.util.ManifestHelper: Creates a Manifest file based on the given properties.
createManifestFile - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo: Flag to choose whether (true) or not (false) the Manifest file should be created.
createPropertiesReport - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo: Flag to choose whether (true) or not (false) the build.properties file should be created.
createPropertiesReport - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo: Flag to choose whether (true) or not (false) the build.properties file should be created.
createRepository(ScmManager) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Creates and configures the SCM repository.
createSorted(Properties) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.SortedProperties: Factory method to create an instance of sorted properties.
createXmlReport - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo: Flag to choose whether (true) or not (false) the XML report should be created.

D

decrypt(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.util.SettingsDecrypter: Decrypts the given value if the security dispatcher is initialized with a valid configuration.
DEFAULT_DATE_PATTERN - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant: The default pattern for the (locale independent) build date.
DEFAULT_RETRY_COUNT - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo: The number of retries to fetch the change log if the first attempt failed to return a non empty set.

E

ensureExists(File) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.util.MojoFileUtils: Ensures that the given directory exists.
execute() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo
execute() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo: Runs the report generation.
execute() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildMetaDataMojo
execute() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildPointMojo
execute() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo
executeReport(Locale) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo
executeReport(Locale) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo

F

factory - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo: The factory to create dependent artifacts.
fetchChangeLog(ScmRepository, ScmProvider) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo: Returns the result of the change log query.
fetchLatestRevisionNumber() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenScmRevisionNumberFetcher: Returns the latest revision number from the SCM.
fetchLatestRevisionNumber() - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.scm.RevisionNumberFetcher: Returns the latest revision number from the SCM.
FileMapping - Class in com.redhat.rcm.maven.plugin.buildmetadata: Maps an properties output file location to a packaging.
FileMapping() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.FileMapping: Default constructor for Maven.
FileMapping(String, File) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.FileMapping: Default constructor for Maven.
FilePathNormalizer - Class in com.redhat.rcm.maven.plugin.buildmetadata.util: Simply passes through the original string.
FilePathNormalizer(String) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.util.FilePathNormalizer: Default constructor.

G

getBasedir() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the value for basedir.
getBaseDir() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.util.FilePathNormalizer: Returns the path to the root folder.
getBuildDatePattern() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the date pattern to use to format the build and revision dates.
getBundle(Locale) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo: Returns the resource bundle for the given locale.
getConnection() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.ScmMetaDataProvider: Delegates call to Scm.getConnection().
getConnectionType() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the value for connectionType.
getConnectionUrl() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the URL to connect to the SCM system.
getDate() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.StringRevision: Returns the revision date.
getDate() - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.scm.Revision: Returns the date of the revision.
getDateFormat() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo: Returns the format of the dates understood by the SCM system.
getDescription(Locale) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo
getFiles() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.LocallyModifiedInfo: Returns the list of files that where reported to be modified.
getId() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.StringRevision: Returns the ID of the revision.
getId() - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.scm.Revision: Returns the identifier of the revision.
getLabel() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Property: Returns the label used for reports.
getLogLevel() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildMetaDataMojo
getMappedName() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Property: Returns the name of the property in the build meta data properties.
getName(Locale) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo
getName() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Property: Returns the name of the system property to add to the build meta data properties.
getOutputDirectory() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo
getOutputFile() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.FileMapping: Returns the name of the properties file to write.
getOutputName() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo
getPackaging() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.FileMapping: Returns the project's packaging as specified in the packaging element of a POM to be mapped to a location to write the build.
getPassPhrase() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmCredentials: Returns the pass phrase (used by java svn).
getPassPhrase() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the pass phrase to authenticate against the SCM system.
getPassword() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmCredentials: Returns the user password (used by svn and starteam protocol).
getPassword() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the password to authenticate against the SCM system.
getPrivateKey() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmCredentials: Returns the private key (used by java svn).
getPrivateKey() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the private key to authenticate against the SCM system.
getProject() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo: Returns the Maven project.
getProject() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo
getProjectProperties(MavenProject) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.BuildPropertiesFileHelper: Fetches the project properties and if null returns a new empty properties instance that is associated with the project.
getProperties() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant.Section: Returns the build meta data properties to be displayed in this section.
getProperties() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.Provider: Returns the value for properties.
getProperty(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.maven.MavenPropertyHelper: Returns the property value specified by the given name.
getQueryRangeInDays() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the range of the query in days to fetch change log entries from the SCM.
getQueryRangeInDays() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo: Returns the range of the query in days to fetch change log entries from the SCM.
getRemoteVersion() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the branch or tag version on the remote server to compare against.
getRemoteVersion() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the branch or tag version on the remote server to compare against.
getRootDirectory() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo: Returns the root directory that contains the files under SCM control.
getScmControl() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the information to control the gathering of SCM meta data.
getScmCrendentials() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the authentication for the SCM server.
getScmDateFormat() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the value for scmDateFormat.
getScmManager() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the manager instance to access the SCM system.
getSection() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Property: Returns the section the property is added to.
getSelectedSystemProperties() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection: Returns the list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
getSiteRenderer() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo
getSkinArtifactFile(MavenProject, ArtifactRepository, ArtifactResolver, ArtifactFactory) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.util.ReportUtils: Returns a file reference to the default skin useful for rendering standalone run reports.
getTagBase() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo: Returns the url of tags base directory (used by svn protocol).
getTagBase() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the url of tags base directory (used by svn protocol).
getTitleKey() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant.Section: Returns the resource key to access the title of the section.
getType() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.Provider: Returns the class to instantiate.
getType() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenRevision: Returns the type of the revision.
getUserName() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmCredentials: Returns the user name (used by svn and starteam protocol).
getUserName() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo: Returns the user name to authenticate against the SCM system.
getValue() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Property: Returns the value provided for the property.





H

handle(File) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.AdditionalLocationsSupport

Handles the given file to be copied to the configured locations.

HostMetaDataProvider - Class in com.redhat.rcm.maven.plugin.buildmetadata.data

Provides information about the host running the build.

HostMetaDataProvider() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.HostMetaDataProvider
 




I

init() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo

Initializes the Mojo.

INSTANCE - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.util.NoopNormalizer

The singleton instance for reuse.

isAddEnvInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for addEnvInfo.

isAddJavaRuntimeInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for addJavaRuntimeInfo.

isAddMavenExecutionInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for addMavenExecutionInfo.

isAddOsInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for addOsInfo.

isAddProjectInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for addProjectInfo.

isAddScmInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Returns the value for addScmInfo.

isCreatePropertiesReport() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Returns the value for createPropertiesReport.

isFailIndicated() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Checks whether the SCM configuration calls for a failure due to changed
 files.

isFailOnLocalModifications() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Returns the value for failOnLocalModifications.

isFailOnLocalModifications() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Returns the flag to fail if local modifications have been found.

isFailOnMissingRevision() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Returns the value for failOnMissingRevision.

isHideCommandLineInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for hideCommandLineInfo.

isHideJavaOptsInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for hideJavaOptsInfo.

isHideMavenOptsInfo() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Returns the value for hideMavenOptsInfo.

isIgnoreDotFilesInBaseDir() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Returns the flag to ignore files and directories starting with a dot for
 checking modified files.

isIgnoreDotFilesInBaseDir() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Returns the flag to ignore files and directories starting with a dot for
 checking modified files.

isIntendedForMiscSection(String) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

Checks if the given property is rejected from being displayed in the misc
 section of a report.

isLocallyModified() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.LocallyModifiedInfo

Returns the flag that shows whether the files are modified (
 true) or not (false).

isOffline() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Returns the value for offline.

isRunAtEndOfBuild() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.Provider

Checks if the provider is configured to be run at the end of the build.

isValidateCheckout() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Returns the value for validateCheckout.





K

keys() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.SortedProperties




L

locale - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

The locale to use regardless of the report.

LocallyModifiedInfo - Class in com.redhat.rcm.maven.plugin.buildmetadata.scm

Stores the information about locally modified files.

LocallyModifiedInfo(boolean, String) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.scm.LocallyModifiedInfo

Default constructor.

localRepository - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

Local Repository.

logLevel - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

Specifies the log level buildmetadata.logLevel used for this
 plugin.





M

manifestFile - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The location of the Manifest file to add the buildmetadata properties to.

ManifestHelper - Class in com.redhat.rcm.maven.plugin.buildmetadata.util

Helper to write the Manifest to.

ManifestHelper(File, String) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.util.ManifestHelper

Default constructor.

manifestSection - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The name of the section within the Manifest file to write the
 buildmetadata properties to.

MAVEN_ACTIVE_PROFILE_PREFIX - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The prefix used to provide active profile information of the build.

MAVEN_EXECUTION_PROPERTIES_PREFIX - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The prefix used to provide execution properties to the build properties
 file.

MavenMetaDataProvider - Class in com.redhat.rcm.maven.plugin.buildmetadata.data

Extracts information from the Maven project, session, and runtime
 information.

MavenMetaDataProvider(MavenProject, MavenSession, RuntimeInformation, MavenMetaDataSelection) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataProvider

Constructor.

MavenMetaDataSelection - Class in com.redhat.rcm.maven.plugin.buildmetadata.data

Defines the Maven information to be included in the build meta data.

MavenMetaDataSelection() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection
 
MavenPropertyHelper - Class in com.redhat.rcm.maven.plugin.buildmetadata.maven

Fetches properties from a Maven project.

MavenPropertyHelper(MavenProject) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.maven.MavenPropertyHelper

Default constructor.

MavenRevision - Class in com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

The revision implementation for the Maven SCM.

MavenRevision(ScmVersion, Date) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenRevision

Default constructor.

MavenScmRevisionNumberFetcher - Class in com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

Implementation on the Maven SCM implementation to fetch the latest revision
 number.

MavenScmRevisionNumberFetcher(ScmManager, ScmConnectionInfo, ScmAccessInfo) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenScmRevisionNumberFetcher

Default constructor.

MetaDataProvider - Interface in com.redhat.rcm.maven.plugin.buildmetadata.data

Interface to add build meta data information.

MetaDataProviderBuilder - Class in com.redhat.rcm.maven.plugin.buildmetadata.data

Configuration instance to create instances of MetaDataProvider.

MetaDataProviderBuilder(MavenProject, MavenSession, RuntimeInformation, ScmInfo) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.MetaDataProviderBuilder

Default constructor.

MojoFileUtils - Class in com.redhat.rcm.maven.plugin.buildmetadata.util

Utilities for Mojos working with files.

MojoIoUtils - Class in com.redhat.rcm.maven.plugin.buildmetadata.util

Utilities for Mojos working with IO.

MojoUtils - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

Utilities for this Mojo.





N

NoopNormalizer - Class in com.redhat.rcm.maven.plugin.buildmetadata.util

Simply passes through the original string.

NoopNormalizer() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.util.NoopNormalizer

Default constructor.

normalize(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.util.FilePathNormalizer

Normalizes the input string.

normalize(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.util.NoopNormalizer

Normalizes the input string.

normalize(String) - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.util.Normalizer

Normalizes the input string.

Normalizer - Interface in com.redhat.rcm.maven.plugin.buildmetadata.util

Normalizes a string.





O

outputDirectory - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

Specifies the directory where the report will written to.





P

prettify(String) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

Prettifies a multi value string that contains brackets.

prettifyFilesValue(Object) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

Prettifies a value string that contains brackets.

project - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The Maven project.

project - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

The Maven project.

project - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider

The Maven project.

PROP_NAME_ARTIFACT_ID - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the artifact ID as read from
 the POM.

PROP_NAME_BUILD_DATE - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the formatted build date.

PROP_NAME_BUILD_DATE_PATTERN - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the pattern of the build date.

PROP_NAME_BUILD_DURATION - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the duration of the build in
 milliseconds.

PROP_NAME_BUILD_TIMESTAMP - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the build timestamp.

PROP_NAME_BUILD_USER - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the build user.

PROP_NAME_BUILD_YEAR - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the build year.

PROP_NAME_COPYRIGHT_YEAR - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the copyright year.

PROP_NAME_FULL_VERSION - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the full version that may
 include the version, the build date, the build number and the revision
 number.

PROP_NAME_GROUP_ID - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the group ID as read from the
 POM.

PROP_NAME_HOSTNAME - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the name of the host the build has
 been run on.

PROP_NAME_JAVA_COMPILER - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the name of the Java compiler being
 executed for the build.

PROP_NAME_JAVA_OPTS - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the Java opts set in the environment.

PROP_NAME_JAVA_RUNTIME_NAME - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the name of Java runtime being
 executed for the build.

PROP_NAME_JAVA_RUNTIME_VERSION - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the version of Java runtime being
 executed for the build.

PROP_NAME_JAVA_VENDOR - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the name of the vendor of Java being
 executed for the build.

PROP_NAME_JAVA_VM - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the name of the Java VM being executed
 for the build.

PROP_NAME_MAVEN_ACTIVE_PROFILES - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that contains names of active profiles during the
 build.

PROP_NAME_MAVEN_CMDLINE - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the command line to start the build.

PROP_NAME_MAVEN_EXECUTION_PROJECT - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that contains the name of the execution project.

PROP_NAME_MAVEN_FILTERS - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that contains the name of the filters being
 registered for the build.

PROP_NAME_MAVEN_GOALS - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the goals given on the command line
 for the build.

PROP_NAME_MAVEN_IS_EXECUTION_ROOT - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that flags if the artifact is build within the
 project that is the execution root.

PROP_NAME_MAVEN_OPTS - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the Maven opts set in the environment.

PROP_NAME_MAVEN_VERSION - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the version of Maven being executed
 for the build.

PROP_NAME_OS_ARCH - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the architecture of the operating
 system the build has been run on.

PROP_NAME_OS_NAME - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the name of the operating system the
 build has been run on.

PROP_NAME_OS_VERSION - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores the version of the operating system
 the build has been run on.

PROP_NAME_PROJECT_CATEGORY - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores a value to categorize the project.

PROP_NAME_PROJECT_HOMEPAGE - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores URL of the project homepage.

PROP_NAME_PROJECT_OPS - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores URL to a page useful for operations
 teams.

PROP_NAME_PROJECT_SUBCATEGORY - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores a value to further categorize the
 project.

PROP_NAME_PROJECT_TAGS - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the property that stores a comma separated list of tags to
 categorize the project.

PROP_NAME_SCM_LOCALLY_MODIFIED - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the information if the local
 sources are modified.

PROP_NAME_SCM_LOCALLY_MODIFIED_FILES - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the files that are locally
 modified.

PROP_NAME_SCM_REVISION_DATE - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the date the revision number
 was set.

PROP_NAME_SCM_REVISION_ID - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the revision number provided
 by the SCM.

PROP_NAME_SCM_URL - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the URL to the SCM server.

PROP_NAME_VERSION - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project property that stores the version as read from the
 POM.

properties - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The list of a system properties or environment variables to be selected by
 the user to include into the build meta data properties.

properties - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo

The list of a system properties or environment variables to be selected by
 the user to include into the build meta data properties.

propertiesOutputFile - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The name of the properties file to write.

Property - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

Defines a property to be selected by the user to include into the build meta
 data properties.

Property() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.common.Property
 
propertyOutputFileMapping - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo

Maps a packaging to a location for the build meta data properties file.

provideBuildMetaData(Properties, ScmInfo, List<Provider>, boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Adds the information as build properties for each provider.

provideBuildMetaData(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.HostMetaDataProvider

Adds the information as build properties.

provideBuildMetaData(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataProvider

Adds the information of the Maven runtime as build properties.

provideBuildMetaData(Properties) - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.data.MetaDataProvider

Adds the information as build properties.

provideBuildMetaData(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.ScmMetaDataProvider

Provides the SCM build information to the property sets if the URL to the
 SCM is provided.

Provider - Class in com.redhat.rcm.maven.plugin.buildmetadata.data

Configuration instance to create instances of
 MetaDataProvider by the
 MetaDataProviderBuilder.

Provider() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.Provider
 
providers - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The list of meta data providers to launch that contribute to the meta data.

provideScmBuildInfo(Properties, ScmControl) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.common.RevisionHelper

Fetches the revision information and adds it to the property sets.

provideSink() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

Ensures that a writeable sink is provided.





R

readBuildPropertiesFile(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.BuildPropertiesFileHelper

Reads the build properties file from stream.

remoteVersion - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The branch or tag version on the remote server to compare against.

renderReport() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildReportRenderer

Renders the report to the instance's sink.

REPORT_PROPERTIES - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

List of properties, organized in sections, relevant to the build report.

ReportUtils - Class in com.redhat.rcm.maven.plugin.buildmetadata.util

Utilities for Maven for generating reports.

resolver - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

The resolver for resolving artifacts.

Revision - Interface in com.redhat.rcm.maven.plugin.buildmetadata.scm

Interface to allow different implementations of the revision information.

RevisionHelper - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

Helper to access the revision information.

RevisionHelper(ScmManager, ScmConnectionInfo, ScmAccessInfo, String) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.common.RevisionHelper

Default constructor.

RevisionNumberFetcher - Interface in com.redhat.rcm.maven.plugin.buildmetadata.scm

Provides means to fetch the revision number.

RUN_AT_BUILD_POINT - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.data.Provider

The name of the property to indicate that a provider is to be run with the
 build point mojo.

runtime - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The runtime information of the Maven instance being executed for the build.

runtime - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider

The runtime information of the Maven instance being executed for the build.





S

ScmAccessInfo - Class in com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

Provides access information to retrieve revision information from the SCM.

ScmAccessInfo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Default constructor.

ScmConnectionInfo - Class in com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

Provides the information required to connect to a SCM system.

ScmConnectionInfo() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo
 
ScmControl - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

Information to control the gathering of SCM meta data.

ScmControl(boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmControl

Default constructor.

ScmCredentials - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

The SCM connection information for authentication.

ScmCredentials(SettingsDecrypter, Settings, String, String, String, String) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmCredentials

Default constructor.

ScmException - Exception in com.redhat.rcm.maven.plugin.buildmetadata.scm

Thrown on any problem fetching SCM information.

ScmException(String, Throwable) - Constructor for exception com.redhat.rcm.maven.plugin.buildmetadata.scm.ScmException

Default Constructor.

ScmException(String) - Constructor for exception com.redhat.rcm.maven.plugin.buildmetadata.scm.ScmException

Convenience constructor providing no cause.

ScmException(Throwable) - Constructor for exception com.redhat.rcm.maven.plugin.buildmetadata.scm.ScmException

Convenience constructor providing no message.

ScmInfo - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

Bundles the SCM information to be passed to meta data providers.

ScmInfo(ScmManager, String, String, File, ScmCredentials, String, int, String, ScmControl, ScmVersion) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.common.ScmInfo

Default constructor.

scmInfo - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider

Information for the SCM provided to the build plugin.

ScmMetaDataProvider - Class in com.redhat.rcm.maven.plugin.buildmetadata.data

Extracts information from the Maven project, session, and runtime
 information.

ScmMetaDataProvider(MavenProject, ScmInfo) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.data.ScmMetaDataProvider

Constructor.

ScmNoRevisionException - Exception in com.redhat.rcm.maven.plugin.buildmetadata.scm

Thrown on any problem fetching SCM revision information.

ScmNoRevisionException(String) - Constructor for exception com.redhat.rcm.maven.plugin.buildmetadata.scm.ScmNoRevisionException

Default constructor.

ScmNoRevisionException(String, Throwable) - Constructor for exception com.redhat.rcm.maven.plugin.buildmetadata.scm.ScmNoRevisionException
 
SdocBuilder - Class in com.redhat.rcm.maven.plugin.buildmetadata.io

Creates an XML report with the build meta data.

SdocBuilder(FilePathNormalizer, Document, Properties, List<Property>) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.io.SdocBuilder

Default constructor.

SECTION_ARTIFACT - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the artifact section.

SECTION_BUILD_DATE - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the build date section.

SECTION_BUILD_JAVA - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the Java build section.

SECTION_BUILD_MAVEN - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the Maven build section.

SECTION_BUILD_MISC - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the miscellaneous build section.

SECTION_BUILD_RUNTIME - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the runtime build section.

SECTION_BUILD_SCM - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the SCM section.

SECTION_PROJECT - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The name of the project section.

serialize(Document, OutputStream) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.util.MojoIoUtils

Writes the DOM document to the given stream in pretty print format.

serialize(Document, OutputStream, boolean) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.util.MojoIoUtils

Writes the DOM document to the given stream.

session - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The Maven session instance.

session - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider

The Maven session instance.

setAddEnvInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for addEnvInfo.

setAddJavaRuntimeInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for addJavaRuntimeInfo.

setAddMavenExecutionInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for addMavenExecutionInfo.

setAddOsInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for addOsInfo.

setAddProjectInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for addProjectInfo.

setAddToGeneratedSources(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.AdditionalLocationsSupport.Config

Sets the flag to control whether or not to copy to
 generated-sources.

setAddToLocations(List<String>) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.AdditionalLocationsSupport.Config

Sets the list of locations the report files are to be copied to.

setCreatePropertiesReport(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Sets the value for createPropertiesReport.

setDateFormat(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Sets the format of the dates understood by the SCM system.

setFailOnLocalModifications(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Sets the flag to fail if local modifications have been found.

setHideCommandLineInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for hideCommandLineInfo.

setHideJavaOptsInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for hideJavaOptsInfo.

setHideMavenOptsInfo(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the value for hideMavenOptsInfo.

setIgnoreDotFilesInBaseDir(boolean) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Sets the flag to ignore files and directories starting with a dot for
 checking modified files.

setLogLevel(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.BuildMetaDataMojo
 
setPassPhrase(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the pass phrase to authenticate against the SCM system.

setPassword(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the password to authenticate against the SCM system.

setPrivateKey(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the private key to authenticate against the SCM system.

setProject(MavenProject) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Sets the Maven project.

setPropertiesOutputFile(File) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Sets the name of the properties file to write.

setQueryRangeInDays(int) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Sets the range of the query in days to fetch change log entries from the
 SCM.

setRemoteVersion(ScmVersion) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the branch or tag version on the remote server to compare against.

setRootDirectory(File) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Sets the root directory that contains the files under SCM control.

setScmConnectionUrl(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the URL to connect to the SCM system.

setSelectedSystemProperties(List<Property>) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

Sets the list of a system properties or environment variables to be
 selected by the user to include into the build meta data properties.

setSession(MavenSession) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Sets the Maven session.

setTagBase(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the url of tags base directory (used by svn protocol).

settingsDecrypter - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Helper to decrypt passwords from the settings handling the location of the
 settings-security.xml file.

SettingsDecrypter - Class in com.redhat.rcm.maven.plugin.buildmetadata.util

Helper to decrypt passwords from the settings.

SettingsDecrypter(SecDispatcher, String) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.util.SettingsDecrypter

Default constructor.

setUserName(String) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Sets the user name to authenticate against the SCM system.

siteRenderer - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

The Doxia site renderer.

skip - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractReportMojo

A simple flag to skip the generation of the reports.

SortedProperties - Class in com.redhat.rcm.maven.plugin.buildmetadata.common

Class for sorting properties.

SortedProperties() - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.common.SortedProperties
 
STANDARD_PROPERTIES - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.common.Constant

The set of standard keys known to be rendered in sections.

StringRevision - Class in com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

Implementation for a simple revision string.

StringRevision(String, Date) - Constructor for class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.StringRevision

Default constructor.





T

TMP_BUILD_END - Static variable in class com.redhat.rcm.maven.plugin.buildmetadata.BuildPointMojo

Constant to store the current time stamp.

toPrettyString(List<?>) - Static method in class com.redhat.rcm.maven.plugin.buildmetadata.common.MojoUtils

Turns the list to its string representation, removing the starting and trailing brackets.

toString() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenRevision

Returns the revision information as a String.

toString() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo

Delegates call to StringBuilder.toString().

toString() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

Returns the string representation of the object.

toString() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.StringRevision

Returns the revision information as a String.

toString() - Method in interface com.redhat.rcm.maven.plugin.buildmetadata.scm.Revision

Returns the revision information as a String.





U

updateMavenEnvironment(Properties, BuildPropertiesFileHelper) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Updates the Maven runtime with build properties.





W

writeDocumentContent() - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.SdocBuilder

Writes the content to the document.

writePropertiesFile(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.BuildPropertiesFileHelper

Writes the build meta data properties to the target file.

writeProtectFiles - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

Flag to choose whether (true) or not (false) to
 write protect the generated buildmetadata files.

writeXmlFile(Properties) - Method in class com.redhat.rcm.maven.plugin.buildmetadata.io.BuildXmlFileHelper

Writes the build meta data XML file to the target file.





X

xmlOutputFile - Variable in class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

The name of the XML report file to write.


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