Package org.apache.juneau.objecttools

Class SortArgs

java.lang.Object

org.apache.juneau.objecttools.SortArgs

public class SortArgs
extends Object

Arguments passed to ObjectSorter.

See Also:

• Object Tools

Constructor Summary

Constructors

Constructor	Description
SortArgs(String sortArgs)	Constructor.
SortArgs(Collection<String> sortArgs)	Constructor.

Method Summary

Modifier and Type	Method	Description
static SortArgs	create(String args)	Static creator.
static SortArgs	create(List<String> args)	Static creator.
Map<String,Boolean>	getSort()	The sort columns.

Methods inherited from class java.lang.Object

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

Constructor Details

SortArgs

public SortArgs(String sortArgs)

Constructor.

Parameters:

sortArgs - Comma-delimited list of sort arguments.
Values are of the following forms:

• "column" - Sort column ascending.
• "column+" - Sort column ascending.
• "column-" - Sort column descending.

SortArgs

public SortArgs(Collection<String> sortArgs)

Constructor.

Parameters:

sortArgs - Sort arguments.
Values are of the following forms:

• "column" - Sort column ascending.
• "column+" - Sort column ascending.
• "column-" - Sort column descending.

Method Details

create

public static SortArgs create(String args)

Static creator.

Parameters:

args - Comma-delimited list of sort arguments.
Values are of the following forms:

• "column" - Sort column ascending.
• "column+" - Sort column ascending.
• "column-" - Sort column descending.

Returns:

A new SortArgs object.

create

public static SortArgs create(List<String> args)

Static creator.

Parameters:

args - Sort arguments.
Values are of the following forms:

• "column" - Sort column ascending.
• "column+" - Sort column ascending.
• "column-" - Sort column descending.

Returns:

A new SortArgs object.

getSort

public Map<String,Boolean> getSort()

The sort columns.

The sort columns are key/value pairs consisting of column-names and direction flags (false = ascending, true = descending).

Returns:

An unmodifiable ordered map of sort columns and directions.