Top Description Fields Constructors Methods
org.apache.tools.ant.util

public Class DeweyDecimal

extends Object
implements Comparable<DeweyDecimal>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Known Direct Subclasses
org.apache.tools.ant.taskdefs.optional.extension.DeweyDecimal
Imports
java.util.StringTokenizer, java.util.stream.Collectors, .IntStream

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.

Field Summary

Modifier and TypeField and Description
private final int[]
components

Array of components that make up DeweyDecimal

Constructor Summary

AccessConstructor and Description
public
DeweyDecimal(final int[]
an array of integer components.
components
)

Construct a DeweyDecimal from an array of integer components.

public
DeweyDecimal(final String
the string in dewey decimal format
string
)

Construct a DeweyDecimal from string in DeweyDecimal format.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

result
compareTo
(DeweyDecimal
another DeweyDecimal to compare with
other
)

Implements java.lang.Comparable.compareTo.

Compares this DeweyDecimal with another one.
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

Returns:

the value of component at index
get
(final int
the index of components
index
)

Return the component at specified index.

public int

Returns:

the number of components in dewey decimal
getSize
()

Return number of components in DeweyDecimal.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean

Returns:

true if equal to other DeweyDecimal, false otherwise
isEqual
(final DeweyDecimal
the other DeweyDecimal
other
)

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

public boolean

Returns:

true if greater than other DeweyDecimal, false otherwise
isGreaterThan
(final DeweyDecimal
the other DeweyDecimal
other
)

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

public boolean

Returns:

true if greater than or equal to other DeweyDecimal, false otherwise
isGreaterThanOrEqual
(final DeweyDecimal
the other DeweyDecimal
other
)

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

public boolean

Returns:

true if less than other DeweyDecimal, false otherwise
isLessThan
(final DeweyDecimal
the other DeweyDecimal
other
)

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

public boolean

Returns:

true if less than or equal to other DeweyDecimal, false otherwise
isLessThanOrEqual
(final DeweyDecimal
the other DeweyDecimal
other
)

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

public String

Returns:

the string representation of DeweyDecimal.
toString
()

Overrides java.lang.Object.toString.

Return string representation of DeweyDecimal.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

componentsback to summary
private final int[] components

Array of components that make up DeweyDecimal

Constructor Detail

DeweyDecimalback to summary
public DeweyDecimal(final int[] components)

Construct a DeweyDecimal from an array of integer components.

Parameters
components:int[]

an array of integer components.

DeweyDecimalback to summary
public DeweyDecimal(final String string) throws NumberFormatException

Construct a DeweyDecimal from string in DeweyDecimal format.

Parameters
string:String

the string in dewey decimal format

Exceptions
NumberFormatException:
if string is malformed

Method Detail

compareToback to summary
public int compareTo(DeweyDecimal other)

Implements java.lang.Comparable.compareTo.

Compares this DeweyDecimal with another one.

Parameters
other:DeweyDecimal

another DeweyDecimal to compare with

Returns:int

result

Annotations
@Override
See Also
java.lang.Comparable#compareTo(Object)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

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

Annotations
@Override
getback to summary
public int get(final int index)

Return the component at specified index.

Parameters
index:int

the index of components

Returns:int

the value of component at index

getSizeback to summary
public int getSize()

Return number of components in DeweyDecimal.

Returns:int

the number of components in dewey decimal

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 equals 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.
Returns:int

a hash code value for this object.

Annotations
@Override
isEqualback to summary
public boolean isEqual(final DeweyDecimal other)

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

Parameters
other:DeweyDecimal

the other DeweyDecimal

Returns:boolean

true if equal to other DeweyDecimal, false otherwise

isGreaterThanback to summary
public boolean isGreaterThan(final DeweyDecimal other)

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

Parameters
other:DeweyDecimal

the other DeweyDecimal

Returns:boolean

true if greater than other DeweyDecimal, false otherwise

isGreaterThanOrEqualback to summary
public boolean isGreaterThanOrEqual(final DeweyDecimal other)

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

Parameters
other:DeweyDecimal

the other DeweyDecimal

Returns:boolean

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

isLessThanback to summary
public boolean isLessThan(final DeweyDecimal other)

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

Parameters
other:DeweyDecimal

the other DeweyDecimal

Returns:boolean

true if less than other DeweyDecimal, false otherwise

isLessThanOrEqualback to summary
public boolean isLessThanOrEqual(final DeweyDecimal other)

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

Parameters
other:DeweyDecimal

the other DeweyDecimal

Returns:boolean

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

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Return string representation of DeweyDecimal.

Returns:String

the string representation of DeweyDecimal.

Annotations
@Override