org.apache.commons.cli2.util
Class Comparators

java.lang.Object
  extended by org.apache.commons.cli2.util.Comparators

public class Comparators
extends java.lang.Object

A collection of Comparators suitable for use with Option instances.


Nested Class Summary
private static class Comparators.Chain
          Chains a series of Comparators together.
private static class Comparators.CommandFirst
           
private static class Comparators.DefaultOptionFirst
           
private static class Comparators.GroupFirst
           
private static class Comparators.Named
           
private static class Comparators.PreferredName
           
private static class Comparators.Required
           
private static class Comparators.Reverse
           
private static class Comparators.SwitchFirst
           
 
Constructor Summary
private Comparators()
           
 
Method Summary
static java.util.Comparator chain(java.util.Comparator[] comparators)
          Chains an array of comparators together.
static java.util.Comparator chain(java.util.Comparator c0, java.util.Comparator c1)
          Chains comparators together.
static java.util.Comparator chain(java.util.Comparator c0, java.util.Comparator c1, java.util.Comparator c2)
          Chains comparators together.
static java.util.Comparator chain(java.util.Comparator c0, java.util.Comparator c1, java.util.Comparator c2, java.util.Comparator c3)
          Chains comparators together.
static java.util.Comparator chain(java.util.Comparator c0, java.util.Comparator c1, java.util.Comparator c2, java.util.Comparator c3, java.util.Comparator c4)
          Chains comparators together.
static java.util.Comparator chain(java.util.List comparators)
          Chains comparators together.
static java.util.Comparator commandFirst()
          Forces Command instances to appear at the beginning of lists
static java.util.Comparator commandLast()
          Forces Command instances to appear at the end of lists
static java.util.Comparator defaultOptionFirst()
          Forces DefaultOption instances to appear at the beginning of lists
static java.util.Comparator defaultOptionLast()
          Forces DefaultOption instances to appear at the end of lists
static java.util.Comparator groupFirst()
          Forces Group instances to appear at the beginning of lists
static java.util.Comparator groupLast()
          Forces Group instances to appear at the end of lists
static java.util.Comparator namedFirst(java.lang.String name)
          Forces Comparators with a particular trigger to appear at the beginning of lists
static java.util.Comparator namedLast(java.lang.String name)
          Forces Comparators with a particular trigger to appear at the end of lists
static java.util.Comparator preferredNameFirst()
          Orders Options by preferredName
static java.util.Comparator preferredNameLast()
          Orders Options by preferredName, reversed
static java.util.Comparator requiredFirst()
          Orders Options grouping required Options first
static java.util.Comparator requiredLast()
          Orders Options grouping required Options last
private static java.util.Comparator reverse(java.util.Comparator wrapped)
          Reverses a comparator's logic.
static java.util.Comparator switchFirst()
          Forces Switch instances to appear at the beginning of lists
static java.util.Comparator switchLast()
          Forces Switch instances to appear at the end of lists
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Comparators

private Comparators()
Method Detail

chain

public static java.util.Comparator chain(java.util.Comparator c0,
                                         java.util.Comparator c1)
Chains comparators together.

Parameters:
c0 - a comparator
c1 - a comparator
Returns:
a chained comparator
See Also:
chain(Comparator[])

chain

public static java.util.Comparator chain(java.util.Comparator c0,
                                         java.util.Comparator c1,
                                         java.util.Comparator c2)
Chains comparators together.

Parameters:
c0 - a comparator
c1 - a comparator
c2 - a comparator
Returns:
a chained comparator
See Also:
chain(Comparator[])

chain

public static java.util.Comparator chain(java.util.Comparator c0,
                                         java.util.Comparator c1,
                                         java.util.Comparator c2,
                                         java.util.Comparator c3)
Chains comparators together.

Parameters:
c0 - a comparator
c1 - a comparator
c2 - a comparator
c3 - a comparator
Returns:
a chained comparator
See Also:
chain(Comparator[])

chain

public static java.util.Comparator chain(java.util.Comparator c0,
                                         java.util.Comparator c1,
                                         java.util.Comparator c2,
                                         java.util.Comparator c3,
                                         java.util.Comparator c4)
Chains comparators together.

Parameters:
c0 - a comparator
c1 - a comparator
c2 - a comparator
c3 - a comparator
c4 - a comparator
Returns:
a chained comparator
See Also:
chain(Comparator[])

chain

public static java.util.Comparator chain(java.util.List comparators)
Chains comparators together.

Parameters:
comparators - a List of comparators to chain together
Returns:
a chained comparator
See Also:
chain(Comparator[])

chain

public static java.util.Comparator chain(java.util.Comparator[] comparators)
Chains an array of comparators together. Each Comparator will be called in turn until one of them return a non-zero value, this value will be returned.

Parameters:
comparators - the array of comparators
Returns:
a chained comparator

reverse

private static java.util.Comparator reverse(java.util.Comparator wrapped)
Reverses a comparator's logic.

Parameters:
wrapped - the Comparator to reverse the logic of
Returns:
a comparator with reverse logic

groupFirst

public static java.util.Comparator groupFirst()
Forces Group instances to appear at the beginning of lists

Returns:
a new comparator
See Also:
Group

groupLast

public static java.util.Comparator groupLast()
Forces Group instances to appear at the end of lists

Returns:
a new comparator
See Also:
Group

switchFirst

public static java.util.Comparator switchFirst()
Forces Switch instances to appear at the beginning of lists

Returns:
a new comparator
See Also:
Switch

switchLast

public static java.util.Comparator switchLast()
Forces Switch instances to appear at the end of lists

Returns:
a new comparator
See Also:
Switch

commandFirst

public static java.util.Comparator commandFirst()
Forces Command instances to appear at the beginning of lists

Returns:
a new comparator
See Also:
Command

commandLast

public static java.util.Comparator commandLast()
Forces Command instances to appear at the end of lists

Returns:
a new comparator
See Also:
Command

defaultOptionFirst

public static java.util.Comparator defaultOptionFirst()
Forces DefaultOption instances to appear at the beginning of lists

Returns:
a new comparator
See Also:
DefaultOption

defaultOptionLast

public static java.util.Comparator defaultOptionLast()
Forces DefaultOption instances to appear at the end of lists

Returns:
a new comparator
See Also:
DefaultOption

namedFirst

public static java.util.Comparator namedFirst(java.lang.String name)
Forces Comparators with a particular trigger to appear at the beginning of lists

Parameters:
name - the trigger name to select
Returns:
a new comparator
See Also:
Option.getTriggers()

namedLast

public static java.util.Comparator namedLast(java.lang.String name)
Forces Comparators with a particular trigger to appear at the end of lists

Parameters:
name - the trigger name to select
Returns:
a new comparator
See Also:
Option.getTriggers()

preferredNameFirst

public static java.util.Comparator preferredNameFirst()
Orders Options by preferredName

Returns:
a new comparator
See Also:
Option.getPreferredName()

preferredNameLast

public static java.util.Comparator preferredNameLast()
Orders Options by preferredName, reversed

Returns:
a new comparator
See Also:
Option.getPreferredName()

requiredFirst

public static java.util.Comparator requiredFirst()
Orders Options grouping required Options first

Returns:
a new comparator
See Also:
Option.isRequired()

requiredLast

public static java.util.Comparator requiredLast()
Orders Options grouping required Options last

Returns:
a new comparator
See Also:
Option.isRequired()