org.codehaus.mojo.versions.api

Class AbstractVersionDetails

java.lang.Object

org.codehaus.mojo.versions.api.AbstractVersionDetails

All Implemented Interfaces:

VersionDetails

Direct Known Subclasses:

ArtifactVersions, PropertyVersions

public abstract class AbstractVersionDetails
extends Object
implements VersionDetails

Base class for VersionDetails.

Since:

1.0-beta-1

Author:

Stephen Connolly

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVersionDetails()

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.
protected Optional<String>	getLowerBound(org.apache.maven.artifact.versioning.ArtifactVersion version, Optional<Segment> unchangedSegment) Returns the string designation of the lower bound version based on the given artifact version and the lowest unchanged segment index (0-based); -1 means that the whole version string can be changed, implying that there is also no string designation of the lower bound 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.
org.apache.maven.artifact.versioning.ArtifactVersion[]	getNewerVersions(String versionString, Optional<Segment> unchangedSegment, 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.
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.
abstract 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.mojo.versions.api.VersionDetails

getVersionComparator

Constructor Detail

AbstractVersionDetails

protected AbstractVersionDetails()

Method Detail

isCurrentVersionDefined

public final boolean isCurrentVersionDefined()

Description copied from interface: VersionDetails

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

Specified by:

isCurrentVersionDefined in interface VersionDetails

Returns:

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

getCurrentVersion

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

Description copied from interface: VersionDetails

Retrieves the current version.

Specified by:

getCurrentVersion in interface VersionDetails

Returns:

The current version (may be null).

setCurrentVersion

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

Description copied from interface: VersionDetails

Sets the current version.

Specified by:

setCurrentVersion in interface VersionDetails

Parameters:

currentVersion - The new current version.

setCurrentVersion

public final void setCurrentVersion(String currentVersion)

Description copied from interface: VersionDetails

Sets the current version.

Specified by:

setCurrentVersion in interface VersionDetails

Parameters:

currentVersion - The new current version.

isIncludeSnapshots

public final boolean isIncludeSnapshots()

Specified by:

isIncludeSnapshots in interface VersionDetails

setIncludeSnapshots

public final void setIncludeSnapshots(boolean includeSnapshots)

Specified by:

setIncludeSnapshots in interface VersionDetails

getVersions

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

Description copied from interface: VersionDetails

Returns all the available versions in increasing order.

Specified by:

getVersions in interface VersionDetails

Returns:

all the available versions in increasing order.

getVersions

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

Description copied from interface: VersionDetails

Returns all available versions in increasing order.

Specified by:

getVersions in interface VersionDetails

Parameters:

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions in increasing order.

getVersions

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

Description copied from interface: VersionDetails

Returns all available versions within the specified version range.

Specified by:

getVersions in interface VersionDetails

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.

getVersions

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

Description copied from interface: VersionDetails

Returns all available versions within the specified bounds.

Specified by:

getVersions in interface VersionDetails

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.

getVersions

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

Description copied from interface: VersionDetails

Returns all available versions within the specified bounds.

Specified by:

getVersions in interface VersionDetails

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.

getNewestVersion

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestVersion in interface VersionDetails

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.

getNewestVersion

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestVersion in interface VersionDetails

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.

getNewestVersion

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestVersion in interface VersionDetails

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.

getNewestVersion

public final 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)

Description copied from interface: VersionDetails

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

Specified by:

getNewestVersion in interface VersionDetails

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

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestVersion in interface VersionDetails

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.

getNewestVersion

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestVersion in interface VersionDetails

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.

containsVersion

public final boolean containsVersion(String version)

Description copied from interface: VersionDetails

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

Specified by:

containsVersion in interface VersionDetails

Parameters:

version - the specific version.

Returns:

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

getNewerVersions

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

Description copied from interface: VersionDetails

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

Specified by:

getNewerVersions in interface VersionDetails

Parameters:

version - current version in String format

includeSnapshots - whether snapshot versions should be included

Returns:

array of newer versions fulfilling the criteria

getNewerVersions

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

Deprecated.

Description copied from interface: VersionDetails

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

Specified by:

getNewerVersions in interface VersionDetails

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

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

Description copied from interface: VersionDetails

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

Specified by:

getNewerVersions in interface VersionDetails

Parameters:

versionString - current version

unchangedSegment - 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)

getVersions

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

Description copied from interface: VersionDetails

Returns all available versions within the specified bounds.

Specified by:

getVersions in interface VersionDetails

Parameters:

restriction - version criteria.

includeSnapshots - true if snapshots are to be included.

Returns:

all available versions within the specified version range.

getVersions

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

Description copied from interface: VersionDetails

Returns all available versions within the specified bounds.

Specified by:

getVersions in interface VersionDetails

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.

getNewestUpdate

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestUpdate in interface VersionDetails

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.

getAllUpdates

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

Description copied from interface: VersionDetails

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

Specified by:

getAllUpdates in interface VersionDetails

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.

getNewestUpdate

public final org.apache.maven.artifact.versioning.ArtifactVersion getNewestUpdate(Optional<Segment> updateScope)

Description copied from interface: VersionDetails

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

Specified by:

getNewestUpdate in interface VersionDetails

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.

getAllUpdates

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

Description copied from interface: VersionDetails

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

Specified by:

getAllUpdates in interface VersionDetails

Parameters:

updateScope - the update scope to include.

Returns:

the all versions after currentVersion within the specified update scope.

getNewestUpdate

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

Description copied from interface: VersionDetails

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

Specified by:

getNewestUpdate in interface VersionDetails

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.

getAllUpdates

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

Description copied from interface: VersionDetails

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

Specified by:

getAllUpdates in interface VersionDetails

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.

getAllUpdates

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

Description copied from interface: VersionDetails

Returns the all versions newer than the specified current version

Specified by:

getAllUpdates in interface VersionDetails

Returns:

the all versions after currentVersion

getAllUpdates

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

Description copied from interface: VersionDetails

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

Specified by:

getAllUpdates in interface VersionDetails

Parameters:

versionRange - the version range to include.

Returns:

the all versions after currentVersion within the specified update scope.

getAllUpdates

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

Description copied from interface: VersionDetails

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

Specified by:

getAllUpdates in interface VersionDetails

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.

getLowerBound

protected Optional<String> getLowerBound(org.apache.maven.artifact.versioning.ArtifactVersion version,
                                         Optional<Segment> unchangedSegment)
                                  throws InvalidSegmentException

Returns the string designation of the lower bound version based on the given artifact version and the lowest unchanged segment index (0-based); -1 means that the whole version string can be changed, implying that there is also no string designation of the lower bound version.

Parameters:

version - ArtifactVersion object specifying the version for which the lower bound is being computed

unchangedSegment - first segment not to be changed; empty() means anything can change

Returns:

Optional string containing the lowest artifact version with the given segment held

Throws:

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