Index (Maven Release APIs 3.0.0-M4 API)

A C D E G I J L N O P R S T U V

A

AbstractReleasePhase - Class in org.apache.maven.shared.release.phase: Base class for all phases.
AbstractReleasePhase() - Constructor for class org.apache.maven.shared.release.phase.AbstractReleasePhase
addDependencyDevelopmentVersion(String, String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
addDependencyOriginalVersion(String, String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
addDependencyReleaseVersion(String, String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
addDevelopmentVersion(String, String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
addReleaseVersion(String, String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
ALTERNATE_PATTERN - Static variable in class org.apache.maven.shared.release.versions.Version
appendDebug(String) - Method in class org.apache.maven.shared.release.ReleaseResult
appendDebug(String, Exception) - Method in class org.apache.maven.shared.release.ReleaseResult
appendError(String) - Method in class org.apache.maven.shared.release.ReleaseResult
appendError(Exception) - Method in class org.apache.maven.shared.release.ReleaseResult
appendError(String, Exception) - Method in class org.apache.maven.shared.release.ReleaseResult
appendInfo(String) - Method in class org.apache.maven.shared.release.ReleaseResult
appendOutput(String) - Method in class org.apache.maven.shared.release.ReleaseResult
appendWarn(String) - Method in class org.apache.maven.shared.release.ReleaseResult

C

clean(List<MavenProject>) - Method in interface org.apache.maven.shared.release.phase.ResourceGenerator: Clean up after a phase if it leaves any additional files in the checkout.
compareTo(Version) - Method in class org.apache.maven.shared.release.versions.Version

D

DEFAULT_MAVEN_EXECUTOR_ID - Static variable in interface org.apache.maven.shared.release.env.ReleaseEnvironment

E

ERROR - Static variable in class org.apache.maven.shared.release.ReleaseResult
execute(ReleaseDescriptor, ReleaseEnvironment, List<MavenProject>) - Method in interface org.apache.maven.shared.release.phase.ReleasePhase: Execute the phase.

G

getActivateProfiles() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getAdditionalArguments() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get additional arguments to pass to any executed Maven process.
getAnnotation() - Method in class org.apache.maven.shared.release.versions.Version
getAnnotationRevision() - Method in class org.apache.maven.shared.release.versions.Version
getAnnotationRevSeparator() - Method in class org.apache.maven.shared.release.versions.Version
getArtifactId() - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
getAutoResolveSnapshots() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Returns whether unresolved SNAPSHOT dependencies should automatically be resolved.
getBranchPhases() - Method in interface org.apache.maven.shared.release.strategy.Strategy
getBuildSeparator() - Method in class org.apache.maven.shared.release.versions.Version
getBuildSpecifier() - Method in class org.apache.maven.shared.release.versions.Version
getCheckModificationExcludes() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Method getCheckModificationExcludes.
getCheckoutDirectory() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the directory where the tag will be checked out.
getCompletedPhase() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the last completed phase.
getCompletionGoals() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the goals to execute in on completion of preparation for the release.
getDefaultDevelopmentVersion() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get default version to use for new working copy.
getDefaultReleaseVersion() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get default version to use for the tagged release or the new branch.
getDependencyDevelopmentVersion(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getDependencyOriginalVersion(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getDependencyReleaseVersion(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getDevelopmentVersion(VersionPolicyRequest) - Method in interface org.apache.maven.shared.release.policy.version.VersionPolicy
getDigits() - Method in class org.apache.maven.shared.release.versions.Version
getEndTime() - Method in class org.apache.maven.shared.release.ReleaseResult
getGroupId() - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
getJavaHome() - Method in interface org.apache.maven.shared.release.env.ReleaseEnvironment
getLocale() - Method in interface org.apache.maven.shared.release.env.ReleaseEnvironment
getLocalRepositoryDirectory() - Method in interface org.apache.maven.shared.release.env.ReleaseEnvironment
getMavenExecutorId() - Method in interface org.apache.maven.shared.release.env.ReleaseEnvironment
getMavenHome() - Method in interface org.apache.maven.shared.release.env.ReleaseEnvironment
getMessage() - Method in exception org.apache.maven.shared.release.versions.VersionComparisonConflictException
getMetaData() - Method in class org.apache.maven.shared.release.policy.version.VersionPolicyRequest
getName(NamingPolicyRequest) - Method in interface org.apache.maven.shared.release.policy.naming.NamingPolicy
getName() - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyResult
getOriginalScmInfo(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getOutput() - Method in class org.apache.maven.shared.release.ReleaseResult
getPerformGoals() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the goals to execute in perform phase for the release.
getPerformPhases() - Method in interface org.apache.maven.shared.release.strategy.Strategy
getPomFileName() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the file name of the POM to pass to any executed Maven process.
getPreparationGoals() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the goals to execute in preparation for the release.
getPreparePhases() - Method in interface org.apache.maven.shared.release.strategy.Strategy
getProjectDevelopmentVersion(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getProjectNamingPolicyId() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
getProjectOriginalVersion(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getProjectReleaseVersion(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
getProjectVersionPolicyId() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the role-hint for the VersionPolicy implementation used to calculate the project versions.
getReleaseResultSuccess() - Method in class org.apache.maven.shared.release.phase.AbstractReleasePhase
getReleaseStrategyId() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the role-hint for the release Strategy implementation.
getReleaseVersion(VersionPolicyRequest) - Method in interface org.apache.maven.shared.release.policy.version.VersionPolicy
getResultCode() - Method in class org.apache.maven.shared.release.ReleaseResult
getRollbackPhases() - Method in interface org.apache.maven.shared.release.strategy.Strategy
getScmBranchBase() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.
getScmBranchCommitComment() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the SCM commit comment when branching.
getScmCommentPrefix() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the prefix of SCM modification messages.
getScmDevelopmentCommitComment() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the SCM commit comment when setting pom.xml back to development.
getScmId() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the id can be used to get the credentials by the server-id from the settings.xml.
getScmPassword() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the password for the user interacting with the scm.
getScmPrivateKey() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get private key for an SSH based SCM repository.
getScmPrivateKeyPassPhrase() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get pass phrase for the private key.
getScmRelativePathProjectDirectory() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get relative path of the project returned by the checkout command.
getScmReleaseCommitComment() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the SCM commit comment when setting pom.xml to release.
getScmReleasedPomRevision() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get nOTE : currently only implemented with svn scm.
getScmReleaseLabel() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get tag or branch name: the identifier for the tag/branch.
getScmRollbackCommitComment() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the SCM commit comment when rolling back.
getScmSourceUrl() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get this is a MavenSCM of where you're going to get the sources to make the release with.
getScmTagBase() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.
getScmTagNameFormat() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get specifies the format for generating a tag name.
getScmUsername() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the user name to interact with the scm.
getSettings() - Method in interface org.apache.maven.shared.release.env.ReleaseEnvironment
getStartTime() - Method in class org.apache.maven.shared.release.ReleaseResult
getUpdateVersionsPhases() - Method in interface org.apache.maven.shared.release.strategy.Strategy
getVersion() - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
getVersion() - Method in class org.apache.maven.shared.release.policy.version.VersionPolicyRequest
getVersion() - Method in class org.apache.maven.shared.release.policy.version.VersionPolicyResult
getVersionString(Version, String, String) - Static method in class org.apache.maven.shared.release.versions.Version
getWaitBeforeTagging() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get wait the specified number of seconds before creating a tag.
getWorkingDirectory() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the directory where the release is performed.
getWorkItem() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get default version to use for new working copy.

I

isAddSchema() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to add the model schema to the top of the rewritten POM if it wasn't there already.
isAllowTimestampedSnapshots() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.
isAutoVersionSubmodules() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to use the parent pom version for submodule versions.
isBranchCreation() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to create a branch instead of do a release.
isCommitByProject() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get the commits must be done by modules or not.
isGenerateReleasePoms() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to generate release POMs.
isInteractive() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.
isLocalCheckout() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network.
isPinExternals() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Determines whether the --pin-externals option in svn copy command is enabled which is new in Subversion 1.9.
isPushChanges() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository.
isRemoteTagging() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get nOTE : currently only implemented with svn scm.
isScmSignTags() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get if the scm provider should sign the tag.
isScmUseEditMode() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to use edit mode when making SCM modifications.
isSnapshot() - Method in class org.apache.maven.shared.release.versions.Version
isSnapshotReleasePluginAllowed() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether a SNAPSHOT of the release plugin is allowed.
isSuppressCommitBeforeTagOrBranch() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to suppress a commit of changes to the working copy before a tag or branch is created.
isUpdateBranchVersions() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to update branch POM versions.
isUpdateDependencies() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get if updateDependencies is false, dependencies version won't be updated to the next development version.
isUpdateVersionsToSnapshot() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to update branch versions to SNAPSHOT.
isUpdateWorkingCopyVersions() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to update working copy POM versions.
isUseReleaseProfile() - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor: Get whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.

J

joinDigitString(List<String>) - Static method in class org.apache.maven.shared.release.versions.Version: Simply joins the items in the list with "." period

L

logDebug(ReleaseResult, String) - Method in class org.apache.maven.shared.release.phase.AbstractReleasePhase
logDebug(ReleaseResult, String, Exception) - Method in class org.apache.maven.shared.release.phase.AbstractReleasePhase
logError(ReleaseResult, String) - Method in class org.apache.maven.shared.release.phase.AbstractReleasePhase
logInfo(ReleaseResult, String) - Method in class org.apache.maven.shared.release.phase.AbstractReleasePhase
logWarn(ReleaseResult, String) - Method in class org.apache.maven.shared.release.phase.AbstractReleasePhase

N

NamingPolicy - Interface in org.apache.maven.shared.release.policy.naming: API for branch and tag naming.
NamingPolicyRequest - Class in org.apache.maven.shared.release.policy.naming
NamingPolicyRequest() - Constructor for class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
NamingPolicyResult - Class in org.apache.maven.shared.release.policy.naming
NamingPolicyResult() - Constructor for class org.apache.maven.shared.release.policy.naming.NamingPolicyResult

O

org.apache.maven.shared.release - package org.apache.maven.shared.release
org.apache.maven.shared.release.config - package org.apache.maven.shared.release.config
org.apache.maven.shared.release.env - package org.apache.maven.shared.release.env
org.apache.maven.shared.release.phase - package org.apache.maven.shared.release.phase
org.apache.maven.shared.release.policy - package org.apache.maven.shared.release.policy
org.apache.maven.shared.release.policy.naming - package org.apache.maven.shared.release.policy.naming
org.apache.maven.shared.release.policy.version - package org.apache.maven.shared.release.policy.version
org.apache.maven.shared.release.strategy - package org.apache.maven.shared.release.strategy
org.apache.maven.shared.release.versions - package org.apache.maven.shared.release.versions

P

PolicyException - Exception in org.apache.maven.shared.release.policy
PolicyException(String) - Constructor for exception org.apache.maven.shared.release.policy.PolicyException
PolicyException(String, Exception) - Constructor for exception org.apache.maven.shared.release.policy.PolicyException

R

ReleaseDescriptor - Interface in org.apache.maven.shared.release.config
ReleaseEnvironment - Interface in org.apache.maven.shared.release.env
ReleaseExecutionException - Exception in org.apache.maven.shared.release: Exception occuring during release execution.
ReleaseExecutionException(String) - Constructor for exception org.apache.maven.shared.release.ReleaseExecutionException
ReleaseExecutionException(String, Throwable) - Constructor for exception org.apache.maven.shared.release.ReleaseExecutionException
ReleaseFailureException - Exception in org.apache.maven.shared.release: A failure during the release process.
ReleaseFailureException(String) - Constructor for exception org.apache.maven.shared.release.ReleaseFailureException
ReleasePhase - Interface in org.apache.maven.shared.release.phase: A phase in the release cycle.
ReleaseResult - Class in org.apache.maven.shared.release
ReleaseResult() - Constructor for class org.apache.maven.shared.release.ReleaseResult
ResourceGenerator - Interface in org.apache.maven.shared.release.phase: Additional interface for ReleasePhase if the phase generates resources, which should be cleaned up afterwards.

S

setAnnotationRevision(String) - Method in class org.apache.maven.shared.release.versions.Version
setArtifactId(String) - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
setBuildSpecifier(String) - Method in class org.apache.maven.shared.release.versions.Version
setDigits(List<String>) - Method in class org.apache.maven.shared.release.versions.Version
setEndTime(long) - Method in class org.apache.maven.shared.release.ReleaseResult
setGroupId(String) - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
setMetaData(Metadata) - Method in class org.apache.maven.shared.release.policy.version.VersionPolicyRequest
setName(String) - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyResult
setResultCode(int) - Method in class org.apache.maven.shared.release.ReleaseResult
setScmRelativePathProjectDirectory(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
setScmReleasedPomRevision(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
setScmReleaseLabel(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
setScmSourceUrl(String) - Method in interface org.apache.maven.shared.release.config.ReleaseDescriptor
setStartTime(long) - Method in class org.apache.maven.shared.release.ReleaseResult
setVersion(String) - Method in class org.apache.maven.shared.release.policy.naming.NamingPolicyRequest
setVersion(String) - Method in class org.apache.maven.shared.release.policy.version.VersionPolicyRequest
setVersion(String) - Method in class org.apache.maven.shared.release.policy.version.VersionPolicyResult
simulate(ReleaseDescriptor, ReleaseEnvironment, List<MavenProject>) - Method in interface org.apache.maven.shared.release.phase.ReleasePhase: Simulate the phase, but don't make any changes to the project.
STANDARD_PATTERN - Static variable in class org.apache.maven.shared.release.versions.Version
Strategy - Interface in org.apache.maven.shared.release.strategy: Interface to override default strategy.
SUCCESS - Static variable in class org.apache.maven.shared.release.ReleaseResult

T

toString() - Method in class org.apache.maven.shared.release.versions.Version

U

UNDEFINED - Static variable in class org.apache.maven.shared.release.ReleaseResult

V

Version - Class in org.apache.maven.shared.release.versions
Version(String) - Constructor for class org.apache.maven.shared.release.versions.Version
VersionComparisonConflictException - Exception in org.apache.maven.shared.release.versions
VersionComparisonConflictException(String, String, int, int) - Constructor for exception org.apache.maven.shared.release.versions.VersionComparisonConflictException
VersionParseException - Exception in org.apache.maven.shared.release.versions
VersionParseException(String) - Constructor for exception org.apache.maven.shared.release.versions.VersionParseException
VersionPolicy - Interface in org.apache.maven.shared.release.policy.version: API for next version calculations, used by maven-release-plugin to suggest release and next develoment versions.
VersionPolicyRequest - Class in org.apache.maven.shared.release.policy.version
VersionPolicyRequest() - Constructor for class org.apache.maven.shared.release.policy.version.VersionPolicyRequest
VersionPolicyResult - Class in org.apache.maven.shared.release.policy.version
VersionPolicyResult() - Constructor for class org.apache.maven.shared.release.policy.version.VersionPolicyResult

A C D E G I J L N O P R S T U V