org.opencms.module

Class CmsModuleVersion

java.lang.Object

org.opencms.module.CmsModuleVersion

All Implemented Interfaces:

java.lang.Comparable<java.lang.Object>

public class CmsModuleVersion
extends java.lang.Object
implements java.lang.Comparable<java.lang.Object>

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object obj)
boolean	equals(java.lang.Object obj)
java.lang.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(java.lang.String version) Sets the version as a String.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final java.lang.String DEFAULT_VERSION

Default version for new modules.

See Also:

Constant Field Values

Constructor Detail

CmsModuleVersion

public CmsModuleVersion(java.lang.String version)

Creates a new module version based on a String.

Parameters:

version - the version to set

Method Detail

compareTo

public int compareTo(java.lang.Object obj)

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Object>

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getVersion

public java.lang.String getVersion()

Returns the current version String.

Returns:

the current version String

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

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

setVersion

public void setVersion(java.lang.String version)

Sets the version as a String.

Parameters:

version - the version String to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()