com.alee.api.version

Class Version

java.lang.Object

com.alee.api.version.Version

All Implemented Interfaces:

Serializable, Comparable<Version>

public final class Version
extends Object
implements Comparable<Version>, Serializable

Semantic version number.

Author:

Mikle Garin

See Also:

Semantic Versioning, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Version(Class cls) Constrcuts new Version.
Version(Package pkg) Constrcuts new Version.
Version(String name, int major, int minor, int patch, VersionType type) Constructs new Version.
Version(String name, String version) Constrcuts new Version.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version version)
int	hashCode()
int	major() Returns major version number.
int	minor() Returns minor version number.
String	name() Returns version name.
int	patch() Returns patch number.
String	toString()
VersionType	type() Returns VersionType.

Methods inherited from class java.lang.Object

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

Constructor Detail

Version

public Version(@Nullable
               Class cls)

Constrcuts new Version.

Parameters:

cls - Class to retrieve version for

Version

public Version(@Nullable
               Package pkg)

Constrcuts new Version.

Parameters:

pkg - Package to retrieve version for

Version

public Version(@Nullable
               String name,
               @Nullable
               String version)

Constrcuts new Version.

Parameters:

name - version name

version - semantic version

Version

public Version(@NotNull
               String name,
               int major,
               int minor,
               int patch,
               @NotNull
               VersionType type)

Constructs new Version.

Parameters:

name - version name

major - major version number

minor - minor version number

patch - patch number

type - VersionType

Method Detail

name

@NotNull
public String name()

Returns version name.

Returns:

version name

major

public int major()

Returns major version number.

Returns:

major version number

minor

public int minor()

Returns minor version number.

Returns:

minor version number

patch

public int patch()

Returns patch number.

Returns:

patch number

type

@NotNull
public VersionType type()

Returns VersionType.

Returns:

VersionType

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Version version)

Specified by:

compareTo in interface Comparable<Version>

toString

@NotNull
public String toString()

Overrides:

toString in class Object