org.codehaus.mojo.versions.api

Interface VersionDetails

All Known Implementing Classes:

AbstractVersionDetails, ArtifactVersions, PluginUpdatesDetails, PropertyVersions

public interface VersionDetails

Created by IntelliJ IDEA.

Since:

1.0-beta-1

Author:

connollys

Method Summary

Modifier and Type	Method and Description
boolean	containsVersion(String version) Returns true if the specific version is in the list of versions.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getAllUpdates() Returns the all versions newer than the specified current version
org.apache.maven.artifact.versioning.ArtifactVersion[]	getAllUpdates(org.apache.maven.artifact.versioning.ArtifactVersion currentVersion, Optional<Segment> updateScope, boolean includeSnapshots) Returns the all versions newer than the specified current version, but within the specified update scope.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getAllUpdates(Optional<Segment> updateScope) Returns the all versions newer than the specified current version, but within the specified update scope.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getAllUpdates(Optional<Segment> updateScope, boolean includeSnapshots) Returns the all versions newer than the specified current version, but within the specified update scope.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getAllUpdates(org.apache.maven.artifact.versioning.VersionRange versionRange) Returns the all versions newer than the specified current version, but within the specified update scope.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getAllUpdates(org.apache.maven.artifact.versioning.VersionRange versionRange, boolean includeSnapshots) Returns the all versions newer than the specified current version, but within the specified update scope.
org.apache.maven.artifact.versioning.ArtifactVersion	getCurrentVersion() Retrieves the current version.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getNewerVersions(String version, boolean includeSnapshots) Returns an array of newer versions than the given version, given whether snapshots should be included.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getNewerVersions(String version, Optional<Segment> upperBoundSegment, boolean includeSnapshots) Deprecated. please use AbstractVersionDetails.getNewerVersions(String, Optional, boolean, boolean), boolean, boolean)} instead
org.apache.maven.artifact.versioning.ArtifactVersion[]	getNewerVersions(String versionString, Optional<Segment> upperBoundSegment, boolean includeSnapshots, boolean allowDowngrade) Returns an array of newer versions than the given version, given the upper bound segment and whether snapshots should be included.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestUpdate(org.apache.maven.artifact.versioning.ArtifactVersion currentVersion, Optional<Segment> updateScope, boolean includeSnapshots) Returns the newest version newer than the specified current version, but within the specified update scope or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestUpdate(Optional<Segment> updateScope) Returns the newest version newer than the specified current version, but within the specified update scope or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestUpdate(Optional<Segment> updateScope, boolean includeSnapshots) Returns the newest version newer than the specified current version, but within the specified update scope or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestVersion(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound, org.apache.maven.artifact.versioning.ArtifactVersion upperBound) Returns the latest version newer than the specified lowerBound, but less than the specified upper bound or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestVersion(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound, org.apache.maven.artifact.versioning.ArtifactVersion upperBound, boolean includeSnapshots) Returns the latest version newer than the specified lowerBound, but less than the specified upper bound or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestVersion(org.apache.maven.artifact.versioning.Restriction restriction, boolean includeSnapshots) Returns the latest version newer than the specified current version, but less than the specified upper bound or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestVersion(org.apache.maven.artifact.versioning.VersionRange versionRange, boolean includeSnapshots) Returns the latest version within the specified version range or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestVersion(org.apache.maven.artifact.versioning.VersionRange versionRange, org.apache.maven.artifact.versioning.Restriction restriction, boolean includeSnapshots) Returns the latest version newer than the specified current version, but less than the specified upper bound or null if no such version exists.
org.apache.maven.artifact.versioning.ArtifactVersion	getNewestVersion(org.apache.maven.artifact.versioning.VersionRange versionRange, org.apache.maven.artifact.versioning.Restriction restriction, boolean includeSnapshots, boolean allowDowngrade) Returns the latest version given the version range, restricition, whether to include snapshots and/or allow downgrades, or null if no such version exists.
VersionComparator	getVersionComparator() Gets the rule for version comparison of this artifact.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions() Returns all the available versions in increasing order.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound, org.apache.maven.artifact.versioning.ArtifactVersion upperBound) Returns all available versions within the specified bounds.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound, org.apache.maven.artifact.versioning.ArtifactVersion upperBound, boolean includeSnapshots) Returns all available versions within the specified bounds.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions(boolean includeSnapshots) Returns all available versions in increasing order.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions(org.apache.maven.artifact.versioning.Restriction restriction, boolean includeSnapshots) Returns all available versions within the specified bounds.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions(org.apache.maven.artifact.versioning.VersionRange versionRange, boolean includeSnapshots) Returns all available versions within the specified version range.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getVersions(org.apache.maven.artifact.versioning.VersionRange versionRange, org.apache.maven.artifact.versioning.Restriction restriction, boolean includeSnapshots) Returns all available versions within the specified bounds.
boolean	isCurrentVersionDefined() Returns true if and only if getCurrentVersion() != null.
boolean	isIncludeSnapshots()
void	setCurrentVersion(org.apache.maven.artifact.versioning.ArtifactVersion currentVersion) Sets the current version.
void	setCurrentVersion(String currentVersion) Sets the current version.
void	setIncludeSnapshots(boolean includeSnapshots)

Method Detail

containsVersion

boolean containsVersion(String version)

Returns true if the specific version is in the list of versions.

Parameters:

version - the specific version.

Returns:

true if the specific version is in the list of versions.

Since:

1.0-beta-1

isCurrentVersionDefined

boolean isCurrentVersionDefined()

Returns true if and only if getCurrentVersion() != null.

Returns:

true if and only if getCurrentVersion() != null.

Since:

1.0-beta-1

setCurrentVersion

void setCurrentVersion(org.apache.maven.artifact.versioning.ArtifactVersion currentVersion)

Sets the current version.

Parameters:

currentVersion - The new current version.

Since:

1.0-beta-1

setCurrentVersion

void setCurrentVersion(String currentVersion)

Sets the current version.

Parameters:

currentVersion - The new current version.

Since:

1.0-beta-1

isIncludeSnapshots

boolean isIncludeSnapshots()

setIncludeSnapshots

void setIncludeSnapshots(boolean includeSnapshots)

getCurrentVersion

org.apache.maven.artifact.versioning.ArtifactVersion getCurrentVersion()

Retrieves the current version.

Returns:

The current version (may be null).

Since:

1.0-beta-1

getVersionComparator

VersionComparator getVersionComparator()

Gets the rule for version comparison of this artifact.

Returns:

the rule for version comparison of this artifact.

Since:

1.0-beta-1

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions()

Returns all the available versions in increasing order.

Returns:

all the available versions in increasing order.

Since:

1.0-alpha-3

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions(boolean includeSnapshots)

Returns all available versions in increasing order.

Parameters:

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions in increasing order.

Since:

1.0-alpha-3

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions(org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                                   boolean includeSnapshots)

Returns all available versions within the specified version range.

Parameters:

versionRange - The version range within which the version must exist.

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions within the specified version range.

Since:

1.0-alpha-3

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound,
                                                                   org.apache.maven.artifact.versioning.ArtifactVersion upperBound)

Returns all available versions within the specified bounds.

Parameters:

lowerBound - the lower bound or null if the lower limit is unbounded.

upperBound - the upper bound or null if the upper limit is unbounded.

Returns:

all available versions within the specified version range.

Since:

1.0-beta-1

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound,
                                                                   org.apache.maven.artifact.versioning.ArtifactVersion upperBound,
                                                                   boolean includeSnapshots)

Returns all available versions within the specified bounds.

Parameters:

lowerBound - the lower bound or null if the lower limit is unbounded.

upperBound - the upper bound or null if the upper limit is unbounded.

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions within the specified version range.

Since:

1.0-beta-1

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions(org.apache.maven.artifact.versioning.Restriction restriction,
                                                                   boolean includeSnapshots)

Returns all available versions within the specified bounds.

Parameters:

restriction - version criteria.

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions within the specified version range.

Since:

1.0-beta-1

getVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getVersions(org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                                   org.apache.maven.artifact.versioning.Restriction restriction,
                                                                   boolean includeSnapshots)

Returns all available versions within the specified bounds.

Parameters:

versionRange - The version range within which the version must exist where null imples [,).

restriction - version criteria.

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions within the specified version range.

Since:

1.0-beta-1

getNewestVersion

org.apache.maven.artifact.versioning.ArtifactVersion getNewestVersion(org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                                      org.apache.maven.artifact.versioning.Restriction restriction,
                                                                      boolean includeSnapshots,
                                                                      boolean allowDowngrade)

Returns the latest version given the version range, restricition, whether to include snapshots and/or allow downgrades, or null if no such version exists.

Parameters:

versionRange - range to look for the versions

restriction - restriction restricting the version lookup

includeSnapshots - true if snapshots are to be included.

allowDowngrade - whether downgrades are allowed

Returns:

the latest version satisfying the conditions or null if no version is available.

getNewestVersion

org.apache.maven.artifact.versioning.ArtifactVersion getNewestVersion(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound,
                                                                      org.apache.maven.artifact.versioning.ArtifactVersion upperBound)

Returns the latest version newer than the specified lowerBound, but less than the specified upper bound or null if no such version exists.

Parameters:

lowerBound - the lower bound or null if the lower limit is unbounded.

upperBound - the upper bound or null if the upper limit is unbounded.

Returns:

the latest version between lowerBound and upperBound or null if no version is available.

Since:

1.0-alpha-3

getNewestVersion

org.apache.maven.artifact.versioning.ArtifactVersion getNewestVersion(org.apache.maven.artifact.versioning.ArtifactVersion lowerBound,
                                                                      org.apache.maven.artifact.versioning.ArtifactVersion upperBound,
                                                                      boolean includeSnapshots)

Returns the latest version newer than the specified lowerBound, but less than the specified upper bound or null if no such version exists.

Parameters:

lowerBound - the lower bound or null if the lower limit is unbounded.

upperBound - the upper bound or null if the upper limit is unbounded.

includeSnapshots - true if snapshots are to be included.

Returns:

the latest version between currentVersion and upperBound or null if no version is available.

Since:

1.0-alpha-3

getNewestVersion

org.apache.maven.artifact.versioning.ArtifactVersion getNewestVersion(org.apache.maven.artifact.versioning.Restriction restriction,
                                                                      boolean includeSnapshots)

Returns the latest version newer than the specified current version, but less than the specified upper bound or null if no such version exists.

Parameters:

restriction - version criteria.

includeSnapshots - true if snapshots are to be included.

Returns:

the latest version between lowerBound and upperBound or null if no version is available.

Since:

1.0-alpha-3

getNewestVersion

org.apache.maven.artifact.versioning.ArtifactVersion getNewestVersion(org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                                      org.apache.maven.artifact.versioning.Restriction restriction,
                                                                      boolean includeSnapshots)

Returns the latest version newer than the specified current version, but less than the specified upper bound or null if no such version exists.

Parameters:

versionRange - The version range within which the version must exist where null imples [,).

restriction - version criteria.

includeSnapshots - true if snapshots are to be included.

Returns:

the latest version between lowerBound and upperBound or null if no version is available.

Since:

1.0-alpha-3

getNewestVersion

org.apache.maven.artifact.versioning.ArtifactVersion getNewestVersion(org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                                      boolean includeSnapshots)

Returns the latest version within the specified version range or null if no such version exists.

Parameters:

versionRange - The version range within which the version must exist.

includeSnapshots - true if snapshots are to be included.

Returns:

the latest version within the version range or null if no version is available.

Since:

1.0-alpha-3

getNewestUpdate

org.apache.maven.artifact.versioning.ArtifactVersion getNewestUpdate(org.apache.maven.artifact.versioning.ArtifactVersion currentVersion,
                                                                     Optional<Segment> updateScope,
                                                                     boolean includeSnapshots)
                                                              throws InvalidSegmentException

Returns the newest version newer than the specified current version, but within the specified update scope or null if no such version exists.

Parameters:

currentVersion - the lower bound or null if the lower limit is unbounded.

updateScope - the update scope to include.

includeSnapshots - true if snapshots are to be included.

Returns:

the newest version after currentVersion within the specified update scope or null if no version is available.

Throws:

InvalidSegmentException - thrown if the updateScope is greater than the number of segments

Since:

1.0-beta-1

getNewerVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getNewerVersions(String version,
                                                                        boolean includeSnapshots)

Returns an array of newer versions than the given version, given whether snapshots should be included.

Parameters:

version - current version in String format

includeSnapshots - whether snapshot versions should be included

Returns:

array of newer versions fulfilling the criteria

getNewerVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getNewerVersions(String version,
                                                                        Optional<Segment> upperBoundSegment,
                                                                        boolean includeSnapshots)
                                                                 throws InvalidSegmentException

Deprecated. please use AbstractVersionDetails.getNewerVersions(String, Optional, boolean, boolean), boolean, boolean)} instead

Returns an array of newer versions than the given version, given the upper bound segment and whether snapshots should be included.

Parameters:

version - current version

upperBoundSegment - the upper bound segment; empty() means no upper bound

includeSnapshots - whether snapshot versions should be included

Returns:

array of newer versions fulfilling the criteria

Throws:

InvalidSegmentException - if the requested segment is outside the bounds (less than 1 or greater than the segment count)

getNewerVersions

org.apache.maven.artifact.versioning.ArtifactVersion[] getNewerVersions(String versionString,
                                                                        Optional<Segment> upperBoundSegment,
                                                                        boolean includeSnapshots,
                                                                        boolean allowDowngrade)
                                                                 throws InvalidSegmentException

Returns an array of newer versions than the given version, given the upper bound segment and whether snapshots should be included.

Parameters:

versionString - current version

upperBoundSegment - the upper bound segment; empty() means no upper bound

includeSnapshots - whether snapshot versions should be included

allowDowngrade - whether to allow downgrading if the current version is a snapshots and snapshots are disallowed

Returns:

array of newer versions fulfilling the criteria

Throws:

InvalidSegmentException - if the requested segment is outside the bounds (less than 1 or greater than the segment count)

getAllUpdates

org.apache.maven.artifact.versioning.ArtifactVersion[] getAllUpdates(org.apache.maven.artifact.versioning.ArtifactVersion currentVersion,
                                                                     Optional<Segment> updateScope,
                                                                     boolean includeSnapshots)
                                                              throws InvalidSegmentException

Returns the all versions newer than the specified current version, but within the specified update scope.

Parameters:

currentVersion - the lower bound or null if the lower limit is unbounded.

updateScope - the update scope to include.

includeSnapshots - true if snapshots are to be included.

Returns:

the all versions after currentVersion within the specified update scope.

Throws:

InvalidSegmentException - thrown if the updateScope is greater than the number of segments

Since:

1.0-beta-1

getNewestUpdate

org.apache.maven.artifact.versioning.ArtifactVersion getNewestUpdate(Optional<Segment> updateScope)
                                                              throws InvalidSegmentException

Returns the newest version newer than the specified current version, but within the specified update scope or null if no such version exists.

Parameters:

updateScope - the update scope to include.

Returns:

the newest version after currentVersion within the specified update scope or null if no version is available.

Throws:

InvalidSegmentException - thrown if the updateScope is greater than the number of segments

Since:

1.0-beta-1

getAllUpdates

org.apache.maven.artifact.versioning.ArtifactVersion[] getAllUpdates(Optional<Segment> updateScope)
                                                              throws InvalidSegmentException

Returns the all versions newer than the specified current version, but within the specified update scope.

Parameters:

updateScope - the update scope to include.

Returns:

the all versions after currentVersion within the specified update scope.

Throws:

InvalidSegmentException - thrown if the updateScope is greater than the number of segments

Since:

1.0-beta-1

getNewestUpdate

org.apache.maven.artifact.versioning.ArtifactVersion getNewestUpdate(Optional<Segment> updateScope,
                                                                     boolean includeSnapshots)
                                                              throws InvalidSegmentException

Returns the newest version newer than the specified current version, but within the specified update scope or null if no such version exists.

Parameters:

updateScope - the update scope to include.

includeSnapshots - true if snapshots are to be included.

Returns:

the newest version after currentVersion within the specified update scope or null if no version is available.

Throws:

InvalidSegmentException - thrown if the updateScope is greater than the number of segments

Since:

1.0-beta-1

getAllUpdates

org.apache.maven.artifact.versioning.ArtifactVersion[] getAllUpdates(Optional<Segment> updateScope,
                                                                     boolean includeSnapshots)
                                                              throws InvalidSegmentException

Returns the all versions newer than the specified current version, but within the specified update scope.

Parameters:

updateScope - the update scope to include.

includeSnapshots - true if snapshots are to be included.

Returns:

the all versions after currentVersion within the specified update scope.

Throws:

InvalidSegmentException - thrown if the updateScope is greater than the number of segments

Since:

1.0-beta-1

getAllUpdates

org.apache.maven.artifact.versioning.ArtifactVersion[] getAllUpdates()

Returns the all versions newer than the specified current version

Returns:

the all versions after currentVersion

Since:

2.13.0

getAllUpdates

org.apache.maven.artifact.versioning.ArtifactVersion[] getAllUpdates(org.apache.maven.artifact.versioning.VersionRange versionRange)

Returns the all versions newer than the specified current version, but within the specified update scope.

Parameters:

versionRange - the version range to include.

Returns:

the all versions after currentVersion within the specified update scope.

Since:

1.0-beta-1

getAllUpdates

org.apache.maven.artifact.versioning.ArtifactVersion[] getAllUpdates(org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                                     boolean includeSnapshots)

Returns the all versions newer than the specified current version, but within the specified update scope.

Parameters:

versionRange - the version range to include.

includeSnapshots - true if snapshots are to be included.

Returns:

the all versions after currentVersion within the specified update scope.

Since:

1.0-beta-1