org.josef.util

Enum ParagraphComparator

java.lang.Object

java.lang.Enum<ParagraphComparator>

org.josef.util.ParagraphComparator

All Implemented Interfaces:

Serializable, Comparable<ParagraphComparator>, Comparator<String>

public enum ParagraphComparator
extends Enum<ParagraphComparator>
implements Comparator<String>

Compares two paragraph numbers. A paragraph number is consists of a group of integers separated by points. For example: 3.2.10
More formally: \d+(\.\d+)*

Version:

1.0 $Revision: 128943 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
int	compare(String left, String right) Compares two paragraph numbers.
static ParagraphComparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static ParagraphComparator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Enum Constant Detail

INSTANCE

public static final ParagraphComparator INSTANCE

The singleton instance.

Method Detail

values

public static ParagraphComparator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ParagraphComparator c : ParagraphComparator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ParagraphComparator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

compare

public int compare(String left,
                   String right)

Compares two paragraph numbers.

Specified by:

compare in interface Comparator<String>

Parameters:

left - The left paragraph number to compare.

right - The right paragraph to compare.

Returns:

A negative integer, zero, or a positive integer as the left argument is less than, equal to, or greater than the right.

Throws:

NumberFormatException - When either the left or the right paragraph number contains a non numeric character.