org.jboss.forge.furnace.versions

Class MultipleVersionRange

java.lang.Object

org.jboss.forge.furnace.versions.MultipleVersionRange

All Implemented Interfaces:

VersionRange

public class MultipleVersionRange
extends Object
implements VersionRange

Construct a version range from a specification.

Author:

Brett Porter, Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
MultipleVersionRange(VersionRange... ranges)

Method Summary

Methods

Modifier and Type	Method and Description
MultipleVersionRange	cloneOf()
boolean	equals(Object obj)
Version	getHighestMatch(List<Version> versions) Return the highest Version of the given List of versions that satisfies all VersionRange instances in this MultipleVersionRange; otherwise, return null if no match was found.
VersionRange	getIntersection(VersionRange... ranges) Return the intersection of this VersionRange with the given VersionRange instances (never null.)
Version	getMax() Get the maximum Version (never null.)
Version	getMin() Get the minimum Version (never null.)
List<VersionRange>	getRanges()
int	hashCode()
boolean	includes(Version version) Return true if this VersionRange includes the given Version.
MultipleVersionRange	intersect(MultipleVersionRange intersection) Creates and returns a new MultipleVersionRange that is a intersection of this version range and the specified version range.
boolean	isEmpty() Return true if this VersionRange is empty.
boolean	isExact() Return true if this VersionRange contains only one single Version.
boolean	isMaxInclusive() Return true if VersionRange.getMax() is inclusive.
boolean	isMinInclusive() Return true if VersionRange.getMin() is inclusive.
Version	matchLowestMatch(List<Version> versions)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MultipleVersionRange

public MultipleVersionRange(VersionRange... ranges)

Method Detail

getRanges

public List<VersionRange> getRanges()

cloneOf

public MultipleVersionRange cloneOf()

intersect

public MultipleVersionRange intersect(MultipleVersionRange intersection)

Creates and returns a new MultipleVersionRange that is a intersection of this version range and the specified version range.

Note: Precedence is given to the recommended version from this version range over the recommended version from the specified version range.

Parameters:

intersection - the MultipleVersionRange that will be used to restrict this version range.

Returns:

the MultipleVersionRange that is a intersection of this version range and the specified version range.

The ranges of the returned version range will be an intersection of the ranges of this version range and the specified version range if both version ranges have ranges. Otherwise, the ranges on the returned range will be empty.

The recommended version of the returned version range will be the recommended version of this version range, provided that ranges falls within the intersected ranges. If the ranges are empty, this version range's recommended version is used if it is not null. If it is null, the specified version range's recommended version is used (provided it is non-null). If no recommended version can be obtained, the returned version range's recommended version is set to null.

Throws:

NullPointerException - if the specified MultipleVersionRange is null.

toString

public String toString()

Overrides:

toString in class Object

getHighestMatch

public Version getHighestMatch(List<Version> versions)

Return the highest Version of the given List of versions that satisfies all VersionRange instances in this MultipleVersionRange; otherwise, return null if no match was found.

matchLowestMatch

public Version matchLowestMatch(List<Version> versions)

includes

public boolean includes(Version version)

Description copied from interface: VersionRange

Return true if this VersionRange includes the given Version.

Specified by:

includes in interface VersionRange

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMin

public Version getMin()

Description copied from interface: VersionRange

Get the minimum Version (never null.)

Specified by:

getMin in interface VersionRange

isMinInclusive

public boolean isMinInclusive()

Description copied from interface: VersionRange

Return true if VersionRange.getMin() is inclusive.

Specified by:

isMinInclusive in interface VersionRange

getMax

public Version getMax()

Description copied from interface: VersionRange

Get the maximum Version (never null.)

Specified by:

getMax in interface VersionRange

isMaxInclusive

public boolean isMaxInclusive()

Description copied from interface: VersionRange

Return true if VersionRange.getMax() is inclusive.

Specified by:

isMaxInclusive in interface VersionRange

isEmpty

public boolean isEmpty()

Description copied from interface: VersionRange

Return true if this VersionRange is empty.

Specified by:

isEmpty in interface VersionRange

isExact

public boolean isExact()

Description copied from interface: VersionRange

Return true if this VersionRange contains only one single Version.

Specified by:

isExact in interface VersionRange

getIntersection

public VersionRange getIntersection(VersionRange... ranges)

Description copied from interface: VersionRange

Return the intersection of this VersionRange with the given VersionRange instances (never null.)

Specified by:

getIntersection in interface VersionRange