fr.brouillard.oss.jgitver

Class Version

java.lang.Object

fr.brouillard.oss.jgitver.Version

All Implemented Interfaces:

Comparable<Version>

public class Version
extends Object
implements Comparable<Version>

Field Summary

Fields

Modifier and Type	Field and Description
static Version	DEFAULT_VERSION
static Version	EMPTY_REPOSITORY_VERSION
static Version	NOT_GIT_VERSION

Constructor Summary

Constructors

Constructor and Description
Version(int major, int minor, int patch, String... qualifiers)
Version(Version other)

Method Summary

Modifier and Type	Method and Description
Version	addQualifier(String qualifier) Creates a new Version object from the current one, but append a new qualifier to it.
int	compareTo(Version o)
boolean	equals(Object o)
int	getMajor() Retrieves the MAJOR part of the version object.
int	getMinor() Retrieves the MINOR part of the version object.
int	getPatch() Retrieves the PATCH part of the version object.
int	hashCode()
Version	increasePatch() Deprecated. use incrementPatch()
Version	incrementMajor() return a new Version object that is a copy of this one where the major number is incremented by one, the minor and patch are set to 0.
Version	incrementMinor() return a new Version object that is a copy of this one where the minor number is incremented by one ; patch version is set to 0.
Version	incrementPatch() return a new Version object that is a copy of this one where the patch number is incremented by one.
boolean	isQualified()
boolean	isSnapshot()
Version	noQualifier() Creates a new Version object from the current one, but removes all qualifiers from it.
static Version	parse(String versionAsString) Creates a Version object by parsing the given string.
Version	removeQualifier(String qualifier) Creates a new Version object from the current one, but removes the given qualifier from it if it exists.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final Version DEFAULT_VERSION

EMPTY_REPOSITORY_VERSION

public static final Version EMPTY_REPOSITORY_VERSION

NOT_GIT_VERSION

public static final Version NOT_GIT_VERSION

Constructor Detail

Version

public Version(Version other)

Version

public Version(int major,
               int minor,
               int patch,
               String... qualifiers)

Method Detail

getMajor

public int getMajor()

Retrieves the MAJOR part of the version object.

Returns:

the number for the major version

getMinor

public int getMinor()

Retrieves the MINOR part of the version object.

Returns:

the number for the minor version

getPatch

public int getPatch()

Retrieves the PATCH part of the version object.

Returns:

the number for the patch version

toString

public String toString()

Overrides:

toString in class Object

addQualifier

public Version addQualifier(String qualifier)

Creates a new Version object from the current one, but append a new qualifier to it.

Parameters:

qualifier - the qualifier to be added

Returns:

a new Version object with exact same major/minor/patch numbers, previous qualifiers and the new added one

removeQualifier

public Version removeQualifier(String qualifier)

Creates a new Version object from the current one, but removes the given qualifier from it if it exists.

Parameters:

qualifier - the qualifier to be removed

Returns:

a new Version object with exact same major/minor/patch numbers, previous qualifiers without the given one

noQualifier

public Version noQualifier()

Creates a new Version object from the current one, but removes all qualifiers from it.

Returns:

a new Version object with exact same major/minor/patch numbers, but without any qualifier

parse

public static Version parse(String versionAsString)

Creates a Version object by parsing the given string.

Parameters:

versionAsString - the string to parse

Returns:

a Version object built from the information of the given representation

Throws:

IllegalStateException - if the given string doesn't match the version

incrementPatch

public Version incrementPatch()

return a new Version object that is a copy of this one where the patch number is incremented by one.

Returns:

a new Version object with incremented patch number

incrementMinor

public Version incrementMinor()

return a new Version object that is a copy of this one where the minor number is incremented by one ; patch version is set to 0.

Returns:

a new Version object with incremented patch number and 0 for patch number

incrementMajor

public Version incrementMajor()

return a new Version object that is a copy of this one where the major number is incremented by one, the minor and patch are set to 0.

Returns:

a new Version object with incremented major number and 0 for minor and patch numbers

increasePatch

public Version increasePatch()

Deprecated. use incrementPatch()

return a new Version object that is a copy of this one where the patch number is incremented by one.

Returns:

a new Version object with incremented patch number

isSnapshot

public boolean isSnapshot()

isQualified

public boolean isQualified()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Version o)

Specified by:

compareTo in interface Comparable<Version>