de.vandermeer.skb.base.strings

Class IdVersionString

Object

IdVersionString

public class IdVersionString
extends Object

Class handling a string as a combination of an identifier and a version part.

Since:

v0.0.8

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 String	id Identifier part of the string.
static IdVersionString	NULL_STRING A NULL IdVersionString for exceptional cases.
static String	NULL_STRING_RETURN
protected VersionString	version

Constructor Summary

Constructors

Constructor and Description
IdVersionString(String idv) Returns a new id/version combined string.
IdVersionString(String id, String version) Returns a new id/version combined string.

Method Summary

Modifier and Type	Method and Description
String	getID() Returns the identifier part of the string
VersionString	getVersion() Returns the version part of the string.
boolean	sameAs(Object obj) Tests if the parameter is the same id and version.
Map<String,String>	toMap() Returns the string as a map using the key "id" for the identifier part and the key "version" for the version part.
String	toString()

Methods inherited from class Object

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

Field Detail

id

protected String id

Identifier part of the string.

version

protected VersionString version

NULL_STRING_RETURN

public static String NULL_STRING_RETURN

NULL_STRING

public static IdVersionString NULL_STRING

A NULL IdVersionString for exceptional cases.

Constructor Detail

IdVersionString

public IdVersionString(String idv)

Returns a new id/version combined string. The format of the input must be id/version (the '/' as separator). Version must be of format a.b.c with a, b and c being integers. In the version, the characters dot, comma, hyphen or blank can be used as separators. The character '/' can only be used as separator of the identifier and the version part.

Parameters:

idv - input string

Throws:

IllegalArgumentException - if the input string was null, empty or of wrong format

IdVersionString

public IdVersionString(String id,
                       String version)

Returns a new id/version combined string. Version must be of format a.b.c with a, b and c being integers. In the version, the characters dot, comma, hyphen or blank can be used as separators.

Parameters:

id - identifier part of the string

version - version part of the string

Throws:

IllegalArgumentException - if the input string was null, empty or of wrong format

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getID

public String getID()

Returns the identifier part of the string

Returns:

identifier part

getVersion

public VersionString getVersion()

Returns the version part of the string.

Returns:

version part

toMap

public Map<String,String> toMap()

Returns the string as a map using the key "id" for the identifier part and the key "version" for the version part.

Returns:

map representation of the string

sameAs

public boolean sameAs(Object obj)

Tests if the parameter is the same id and version.

Parameters:

obj - object to test

Returns:

true if the parameter is an IdVersionString or a string with the same identifier and the same version, false otherwise