de.vandermeer.skb.base.strings

Class VersionString

Object

VersionString

public class VersionString
extends Object

A class for parsing a version string with major, minor and patch elements.

Since:

v0.0.6

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	major Major part of the version.
protected int	minor Minor part of the version.
protected int	patch Patch part of the version.
protected char	separator Separator character for toString.

Constructor Summary

Constructors

Constructor and Description
VersionString(int major, int minor, int patch) Creates a new version string from integer values.
VersionString(String version) Creates a new version object from a string.

Method Summary

Modifier and Type	Method and Description
Integer	getMajor() Returns the major part of the version.
Integer	getMinor() Returns the minor part of the version.
Integer	getPatch() Returns the patch part of the version.
void	setSeparator(char c)
Map<String,Integer>	toMap() Returns the string as a map using the key "major" for the major part, the key "minor" for the minor part and the key "patch" for the patch part.
String	toString()

Methods inherited from class Object

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

Field Detail

major

protected int major

Major part of the version.

minor

protected int minor

Minor part of the version.

patch

protected int patch

Patch part of the version.

separator

protected char separator

Separator character for toString.

Constructor Detail

VersionString

public VersionString(String version)

Creates a new version object from a string. The default value for string to integer conversion is -1.

Parameters:

version - version string in the format "a.b.c" or "a-b-c" with a, b and c being integers, for instance 0.0.2. The string will be split, all supported characters are: comma, dot, hyphen and blank; or combinations of them.

Throws:

IllegalArgumentException - if the version string is null or empty or in the wrong format

VersionString

public VersionString(int major,
                     int minor,
                     int patch)

Creates a new version string from integer values.

Parameters:

major - major part of the version

minor - minor part of the version

patch - patch part of the version

Method Detail

getMajor

public Integer getMajor()

Returns the major part of the version.

Returns:

major part

getMinor

public Integer getMinor()

Returns the minor part of the version.

Returns:

minor part

toMap

public Map<String,Integer> toMap()

Returns the string as a map using the key "major" for the major part, the key "minor" for the minor part and the key "patch" for the patch part.

Returns:

map representation of the string

getPatch

public Integer getPatch()

Returns the patch part of the version.

Returns:

patch part

setSeparator

public void setSeparator(char c)

toString

public String toString()

Overrides:

toString in class Object