Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.util
Class VersionNumber
java.lang.Object
  org.alfresco.util.VersionNumber
All Implemented Interfaces:
Comparable<VersionNumber>, Serializable

@org.alfresco.api.AlfrescoPublicApi
public final class VersionNumber
extends Object
implements Comparable<VersionNumber>, Serializable
Immutable class to encapsulate a version number string. A valid version number string can be made up of any number of numberical parts all delimited by '.'.
Author:
Roy Wetherall
See Also:
Serialized Form

Field Summary
VERSION_BIG
          A convenient '999' version
VERSION_ZERO
          A convenient '0' version
Constructor Summary
VersionNumber(String version)
          Constructror, expects a valid version string.
Method Summary
int
compareTo(VersionNumber obj)
          Compares the passed version to this.
boolean
equals(Object obj)
          Equals implementation
int
getPart(int index)
          Helper method to the the part based on the index, if an invalid index is supplied 0 is returned.
int[]
getParts()
          Get the various parts of the version
int
hashCode()
          Hash code implementation
toString()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Field Detail
VERSION_BIG
public static final VersionNumber VERSION_BIG
A convenient '999' version

VERSION_ZERO
public static final VersionNumber VERSION_ZERO
A convenient '0' version
Constructor Detail
VersionNumber
public VersionNumber(String version)
Constructror, expects a valid version string. A AlfrescoRuntimeException will be throw if an invalid version is encountered.
Parameters:
version - the version string
Method Detail
getParts
public int[] getParts()
Get the various parts of the version
Returns:
array containing the parts of the version

compareTo
public int compareTo(VersionNumber obj)
Compares the passed version to this. Determines whether they are equal, greater or less than this version.
Specified by:
compareTo in interface Comparable<T>
Parameters:
obj - the other version number
Returns:
-1 if the passed version is less that this, 0 if they are equal, 1 if the passed version is greater

getPart
public int getPart(int index)
Helper method to the the part based on the index, if an invalid index is supplied 0 is returned.
Parameters:
index - the index
Returns:
the part value, 0 if the index is invalid

hashCode
public int hashCode()
Hash code implementation
Overrides:
hashCode in class Object

equals
public boolean equals(Object obj)
Equals implementation
Overrides:
equals in class Object

toString
public String toString()
Overrides:
toString in class Object

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.