co.cask.cdap.proto.artifact

Class ArtifactRange

java.lang.Object

co.cask.cdap.proto.artifact.ArtifactRange

public class ArtifactRange
extends Object

Represents a range of versions for an artifact. The lower version is inclusive and the upper version is exclusive.

Constructor Summary

Constructors

Constructor and Description
ArtifactRange(Id.Namespace namespace, String name, ArtifactVersion lower, ArtifactVersion upper)
ArtifactRange(Id.Namespace namespace, String name, ArtifactVersion lower, boolean isLowerInclusive, ArtifactVersion upper, boolean isUpperInclusive)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
ArtifactVersion	getLower()
String	getName()
Id.Namespace	getNamespace()
ArtifactVersion	getUpper()
int	hashCode()
static ArtifactRange	parse(Id.Namespace namespace, String artifactRangeStr) Parses an unnamespaced string representation of an artifact range.
static ArtifactRange	parse(String artifactRangeStr) Parses the string representation of an artifact range, which is of the form: {namespace}:{name}[{lower-version},{upper-version}].
String	toNonNamespacedString() Return the range as a string without the namespace.
String	toString()
boolean	versionIsInRange(ArtifactVersion version)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactRange

public ArtifactRange(Id.Namespace namespace,
             String name,
             ArtifactVersion lower,
             ArtifactVersion upper)

ArtifactRange

public ArtifactRange(Id.Namespace namespace,
             String name,
             ArtifactVersion lower,
             boolean isLowerInclusive,
             ArtifactVersion upper,
             boolean isUpperInclusive)

Method Detail

getNamespace

public Id.Namespace getNamespace()

getName

public String getName()

getLower

public ArtifactVersion getLower()

getUpper

public ArtifactVersion getUpper()

versionIsInRange

public boolean versionIsInRange(ArtifactVersion version)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toNonNamespacedString

public String toNonNamespacedString()

Return the range as a string without the namespace. For example, 'my-functions[1.0.0,2.0.0)'.

Returns:

the range as a string without the namespace.

toString

public String toString()

Overrides:

toString in class Object

parse

public static ArtifactRange parse(String artifactRangeStr)
                           throws InvalidArtifactRangeException

Parses the string representation of an artifact range, which is of the form: {namespace}:{name}[{lower-version},{upper-version}]. This is what is returned by toString(). For example, default:my-functions[1.0.0,2.0.0) will correspond to an artifact name of my-functions with a lower version of 1.0.0 and an upper version of 2.0.0 in the default namespace.

Parameters:

artifactRangeStr - the string representation to parse

Returns:

the ArtifactRange corresponding to the given string

Throws:

InvalidArtifactRangeException - if the string is malformed, or if the lower version is higher than the upper

parse

public static ArtifactRange parse(Id.Namespace namespace,
                  String artifactRangeStr)
                           throws InvalidArtifactRangeException

Parses an unnamespaced string representation of an artifact range. It is expected to be of the form: {name}[{lower-version},{upper-version}]. Square brackets are inclusive, and parentheses are exclusive. For example, my-functions[1.0.0,2.0.0) will correspond to an artifact name of my-functions with a lower version of 1.0.0 and an upper version of 2.0.0.

Parameters:

namespace - the namespace of the artifact range

artifactRangeStr - the string representation to parse

Returns:

the ArtifactRange corresponding to the given string

Throws:

InvalidArtifactRangeException - if the string is malformed, or if the lower version is higher than the upper