org.jdesktop.swingx.decorator
Class SortOrder

java.lang.Object
  org.jdesktop.swingx.decorator.SortOrder

public final class SortOrder
extends Object

Encasulates sort state. There are several conenience methods to simplify usage of the three possible states (unsorted, ascending sorted, descending sorted). PENDING: incomplete.

Field Summary

static SortOrder	ASCENDING
static SortOrder	DESCENDING
static SortOrder	UNSORTED

Method Summary

boolean	isAscending() Convenience to check for ascending sort order.
boolean	isSorted() Convenience to check if the order is sorted.
boolean	isSorted(boolean ascending)
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ASCENDING

public static final SortOrder ASCENDING

DESCENDING

public static final SortOrder DESCENDING

UNSORTED

public static final SortOrder UNSORTED

Method Detail

isSorted

public boolean isSorted()

Convenience to check if the order is sorted.

Returns:

false if unsorted, true for ascending/descending.

isSorted

public boolean isSorted(boolean ascending)

isAscending

public boolean isAscending()

Convenience to check for ascending sort order. PENDING: is this helpful at all?

Returns:

true if ascendingly sorted, false for unsorted/descending.

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.