org.apache.tools.ant.util

Class DeweyDecimal

java.lang.Object

org.apache.tools.ant.util.DeweyDecimal

All Implemented Interfaces:

Comparable<DeweyDecimal>

public class DeweyDecimal
extends Object
implements Comparable<DeweyDecimal>

Utility class to contain version numbers in "Dewey Decimal" syntax. Numbers in the "Dewey Decimal" syntax consist of positive decimal integers separated by periods ".". For example, "2.0" or "1.2.3.4.5.6.7". This allows an extensible number to be used to represent major, minor, micro, etc versions. The version number must begin with a number.

Constructor Summary

Constructors

Constructor and Description
DeweyDecimal(int[] components) Construct a DeweyDecimal from an array of integer components.
DeweyDecimal(String string) Construct a DeweyDecimal from string in DeweyDecimal format.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DeweyDecimal other) Compares this DeweyDecimal with another one.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	get(int index) Return the component at specified index.
int	getSize() Return number of components in DeweyDecimal.
int	hashCode() Returns a hash code value for the object.
boolean	isEqual(DeweyDecimal other) Return true if this DeweyDecimal is equal to the other DeweyDecimal.
boolean	isGreaterThan(DeweyDecimal other) Return true if this DeweyDecimal is greater than the other DeweyDecimal.
boolean	isGreaterThanOrEqual(DeweyDecimal other) Return true if this DeweyDecimal is greater than or equal to the other DeweyDecimal.
boolean	isLessThan(DeweyDecimal other) Return true if this DeweyDecimal is less than the other DeweyDecimal.
boolean	isLessThanOrEqual(DeweyDecimal other) Return true if this DeweyDecimal is less than or equal to the other DeweyDecimal.
String	toString() Return string representation of DeweyDecimal.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeweyDecimal

public DeweyDecimal(int[] components)

Construct a DeweyDecimal from an array of integer components.

Parameters:

components - an array of integer components.

DeweyDecimal

public DeweyDecimal(String string)
             throws NumberFormatException

Construct a DeweyDecimal from string in DeweyDecimal format.

Parameters:

string - the string in dewey decimal format

Throws:

NumberFormatException - if string is malformed

Method Detail

compareTo

public int compareTo(DeweyDecimal other)

Compares this DeweyDecimal with another one.

Specified by:

compareTo in interface Comparable<DeweyDecimal>

Parameters:

other - another DeweyDecimal to compare with

Returns:

result

See Also:

Comparable.compareTo(Object)

equals

public boolean equals(Object o)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

get

public int get(int index)

Return the component at specified index.

Parameters:

index - the index of components

Returns:

the value of component at index

getSize

public int getSize()

Return number of components in DeweyDecimal.

Returns:

the number of components in dewey decimal

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

isEqual

public boolean isEqual(DeweyDecimal other)

Return true if this DeweyDecimal is equal to the other DeweyDecimal.

Parameters:

other - the other DeweyDecimal

Returns:

true if equal to other DeweyDecimal, false otherwise

isGreaterThan

public boolean isGreaterThan(DeweyDecimal other)

Return true if this DeweyDecimal is greater than the other DeweyDecimal.

Parameters:

other - the other DeweyDecimal

Returns:

true if greater than other DeweyDecimal, false otherwise

isGreaterThanOrEqual

public boolean isGreaterThanOrEqual(DeweyDecimal other)

Return true if this DeweyDecimal is greater than or equal to the other DeweyDecimal.

Parameters:

other - the other DeweyDecimal

Returns:

true if greater than or equal to other DeweyDecimal, false otherwise

isLessThan

public boolean isLessThan(DeweyDecimal other)

Return true if this DeweyDecimal is less than the other DeweyDecimal.

Parameters:

other - the other DeweyDecimal

Returns:

true if less than other DeweyDecimal, false otherwise

isLessThanOrEqual

public boolean isLessThanOrEqual(DeweyDecimal other)

Return true if this DeweyDecimal is less than or equal to the other DeweyDecimal.

Parameters:

other - the other DeweyDecimal

Returns:

true if less than or equal to other DeweyDecimal, false otherwise

toString

public String toString()

Return string representation of DeweyDecimal.

Overrides:

toString in class Object

Returns:

the string representation of DeweyDecimal.