com.atlassian.maven.plugins.jgitflow.provider

Interface VersionProvider

All Known Implementing Classes:

DefaultVersionProvider

public interface VersionProvider

Helper class for getting a map that contains module -> version strings. This is used to get versions for all projects/submodule in a maven reacotr list

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getLastReleaseVersions(org.apache.maven.project.MavenProject rootProject) Returns the last release versions for all of the projects in the reactor.
Map<String,String>	getNextDevelopmentVersions(ProjectCacheKey cacheKey, List<org.apache.maven.project.MavenProject> reactorProjects) Returns the (next) development versions for all of the projects in the reactor.
Map<String,String>	getNextHotfixVersions(ProjectCacheKey cacheKey, List<org.apache.maven.project.MavenProject> reactorProjects) Returns the (next) hotfix versions for all of the projects in the reactor.
Map<String,String>	getNextReleaseVersions(ProjectCacheKey cacheKey, List<org.apache.maven.project.MavenProject> reactorProjects) Returns the (next) release versions for all of the projects in the reactor.
Map<String,String>	getNextVersionsForType(VersionType versionType, ProjectCacheKey cacheKey, List<org.apache.maven.project.MavenProject> reactorProjects)
Map<String,String>	getOriginalVersions(List<org.apache.maven.project.MavenProject> reactorProjects) Returns the current versions for all of the projects in the reactor.
Map<String,String>	getOriginalVersions(ProjectCacheKey cacheKey, List<org.apache.maven.project.MavenProject> reactorProjects) Returns the current versions for all of the projects in the reactor.
String	getRootVersion(List<org.apache.maven.project.MavenProject> reactorProjects)
String	getRootVersion(ProjectCacheKey cacheKey, List<org.apache.maven.project.MavenProject> reactorProjects)

Method Detail

getNextVersionsForType

Map<String,String> getNextVersionsForType(VersionType versionType,
                                          ProjectCacheKey cacheKey,
                                          List<org.apache.maven.project.MavenProject> reactorProjects)
                                   throws MavenJGitFlowException

Throws:

MavenJGitFlowException

getNextReleaseVersions

Map<String,String> getNextReleaseVersions(ProjectCacheKey cacheKey,
                                          List<org.apache.maven.project.MavenProject> reactorProjects)
                                   throws MavenJGitFlowException

Returns the (next) release versions for all of the projects in the reactor. If defaultReleaseVersion is defined, it will use that for the root project as well as all sub modules if autoVersionSubmodules is true. If defaultReleaseVersion is not defined, or if autoVersionSubmodules is false, it will prompt the user for the release version for any version in the reactor that is currently a SNAPSHOT

Parameters:

cacheKey - The cacheKey to use when looking for versions so we don't have to loop over the reactor everytime

reactorProjects - The set of reactorProjects to loop over

Returns:

A Map where the key is the project/module key and the value is the release version

Throws:

MavenJGitFlowException

getNextHotfixVersions

Map<String,String> getNextHotfixVersions(ProjectCacheKey cacheKey,
                                         List<org.apache.maven.project.MavenProject> reactorProjects)
                                  throws MavenJGitFlowException

Returns the (next) hotfix versions for all of the projects in the reactor. If defaultReleaseVersion is defined, it will use that for the root project as well as all sub modules if autoVersionSubmodules is true. If defaultReleaseVersion is not defined, or if autoVersionSubmodules is false, it will prompt the user for the hotfix version for any version in the reactor that is currently a SNAPSHOT

Parameters:

cacheKey - The cacheKey to use when looking for versions so we don't have to loop over the reactor everytime

reactorProjects - The set of reactorProjects to loop over

Returns:

A Map where the key is the project/module key and the value is the hotfix version

Throws:

MavenJGitFlowException

getNextDevelopmentVersions

Map<String,String> getNextDevelopmentVersions(ProjectCacheKey cacheKey,
                                              List<org.apache.maven.project.MavenProject> reactorProjects)
                                       throws MavenJGitFlowException

Returns the (next) development versions for all of the projects in the reactor. If defaultDevelopmentVersion is defined, it will use that for the root project as well as all sub modules if autoVersionSubmodules is true. If defaultDevelopmentVersion is not defined, or if autoVersionSubmodules is false, it will prompt the user for the development version for any version in the reactor that is currently a not a SNAPSHOT

Parameters:

cacheKey - The cacheKey to use when looking for versions so we don't have to loop over the reactor everytime

reactorProjects - The set of reactorProjects to loop over

Returns:

A Map where the key is the project/module key and the value is the release version

Throws:

MavenJGitFlowException

getLastReleaseVersions

Map<String,String> getLastReleaseVersions(org.apache.maven.project.MavenProject rootProject)
                                   throws MavenJGitFlowException

Returns the last release versions for all of the projects in the reactor.

Returns:

A Map where the key is the project/module key and the value is the release version

Throws:

MavenJGitFlowException

getOriginalVersions

Map<String,String> getOriginalVersions(ProjectCacheKey cacheKey,
                                       List<org.apache.maven.project.MavenProject> reactorProjects)

Returns the current versions for all of the projects in the reactor.

Parameters:

cacheKey - The cacheKey to use when looking for versions so we don't have to loop over the reactor everytime

reactorProjects - The set of reactorProjects to loop over

Returns:

A Map where the key is the project/module key and the value is the version

getOriginalVersions

Map<String,String> getOriginalVersions(List<org.apache.maven.project.MavenProject> reactorProjects)

Returns the current versions for all of the projects in the reactor. This method never looks up from cache.

Parameters:

reactorProjects - The set of reactorProjects to loop over

Returns:

A Map where the key is the project/module key and the value is the version

getRootVersion

String getRootVersion(ProjectCacheKey cacheKey,
                      List<org.apache.maven.project.MavenProject> reactorProjects)

getRootVersion

String getRootVersion(List<org.apache.maven.project.MavenProject> reactorProjects)