Package org.opencms.module

Class CmsModuleVersion

java.lang.Object

org.opencms.module.CmsModuleVersion

All Implemented Interfaces:

Serializable, Comparable<Object>

public class CmsModuleVersion
extends Object
implements Comparable<Object>, Serializable

A version number for an OpenCms module.

A module version number has the form n1.n2.n3.n4. Only n1 is required, n2 - n4 are optional.

The valid range for each n is 0 - 999. Examples for valid version numbers are 0.9, 1.0.0.5 or 5. The maximum version number is 999.999.999.999.

The comparison is started with n1 being the most important value, followed by n2 - n4. For example 5.0.0.1 > 4.999.999.999 since 5 > 4.

For any n1 - n4, if n > 0 leading zeros are ignored. So 001.002.004.004 = 1.2.3.4. Unrequired leading zeros are automatically stripped from version numbers.

Since:

6.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VERSION	Default version for new modules.

Constructor Summary

Constructors

Constructor	Description
CmsModuleVersion(String version)	Creates a new module version based on a String.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object obj)
boolean	equals(Object obj)
String	getVersion()	Returns the current version String.
int	hashCode()
protected void	increment()	Increments this version number by 1 in the last digit.
protected boolean	isUpdated()	Returns the updated status.
protected void	setUpdated(boolean updated)	Sets the updated status.
void	setVersion(String version)	Sets the version as a String.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_VERSION

public static final String DEFAULT_VERSION

Default version for new modules.

See Also:

• Constant Field Values

Constructor Details

CmsModuleVersion

public CmsModuleVersion(String version)

Creates a new module version based on a String.

Parameters:

version - the version to set

Method Details

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable<Object>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getVersion

public String getVersion()

Returns the current version String.

Returns:

the current version String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

setVersion

public void setVersion(String version)

Sets the version as a String.

Parameters:

version - the version String to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

increment

protected void increment()

Increments this version number by 1 in the last digit.

isUpdated

protected boolean isUpdated()

Returns the updated status.

Returns:

the updated status

setUpdated

protected void setUpdated(boolean updated)

Sets the updated status.

Parameters:

updated - the updated status to set