io.cdap.cdap.api.artifact

Class ArtifactVersion

java.lang.Object

io.cdap.cdap.api.artifact.ArtifactVersion

All Implemented Interfaces:

Comparable<ArtifactVersion>

@Beta
public final class ArtifactVersion
extends Object
implements Comparable<ArtifactVersion>

Represents version of an artifact. It will try to parse the version string of format

 
 parse version string in format of [major].[minor].[fix](-|.)[suffix]
 
 

Constructor Summary

Constructors

Constructor and Description
ArtifactVersion(String str) Constructs an instance by parsing the given string.
ArtifactVersion(String str, boolean matchSuffix) Constructs an instance by parsing the given string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ArtifactVersion other)
boolean	equals(Object o)
Integer	getFix() get the fix version of artifact
Integer	getMajor() get the major version of artifact
Integer	getMinor() get the minor version of artifact
String	getSuffix() get the artifact version suffix
String	getVersion() get the version string of artifact
int	hashCode()
boolean	isSnapshot() get if artifact version is a snapshot version
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactVersion

public ArtifactVersion(String str)

Constructs an instance by parsing the given string. If the string does not match the version pattern, getVersion() will return null.

Parameters:

str - the version string. The whole string needs to match with the version pattern supported by this class.

ArtifactVersion

public ArtifactVersion(String str,
                       boolean matchSuffix)

Constructs an instance by parsing the given string. If the string does not match the version pattern, getVersion() will return null.

Parameters:

str - the version string.

matchSuffix - if true, try to match the version pattern by the suffix of the string. Otherwise match the whole string.

Method Detail

getVersion

@Nullable
public String getVersion()

get the version string of artifact

Returns:

artifact version string

getMajor

@Nullable
public Integer getMajor()

get the major version of artifact

Returns:

major version of artifact

getMinor

@Nullable
public Integer getMinor()

get the minor version of artifact

Returns:

minor version of artifact

getFix

@Nullable
public Integer getFix()

get the fix version of artifact

Returns:

fix version of artifact

getSuffix

@Nullable
public String getSuffix()

get the artifact version suffix

Returns:

artifact version suffix

isSnapshot

public boolean isSnapshot()

get if artifact version is a snapshot version

Returns:

true if artifact version is snapshot, false otherwise

compareTo

public int compareTo(ArtifactVersion other)

Specified by:

compareTo in interface Comparable<ArtifactVersion>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object