Package org.kiwiproject.jdbc

Enum Class SqlOrder

java.lang.Object

java.lang.Enum<SqlOrder>

org.kiwiproject.jdbc.SqlOrder

All Implemented Interfaces:

Serializable, Comparable<SqlOrder>, Constable

public enum SqlOrder
extends Enum<SqlOrder>

Simple enum that represents the values for SQL ORDER BY clauses.

This is useful in building queries, for example when using JDBI and the SQL objects API you might need to add dynamic ordering based on user input but want to ensure no SQL injection attack is possible. So you would accept user input and then use from(String) to get a SqlOrder instance. Then, you could use it in a JDBI SqlQuery annotation as one example.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASC
DESC

Method Summary

Modifier and Type	Method	Description
static SqlOrder	from(String value)	Given a string value, return a SqlOrder, ignoring case and leading/trailing whitespace.
<T> List<T>	searchWith(Supplier<List<T>> ascSearch, Supplier<List<T>> descSearch)	Perform a search in either ascending or descending order using the given Supplier instances.
String	toSql()	Return a string that can be used directly in a SQL ORDER BY clause.
static SqlOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SqlOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASC

public static final SqlOrder ASC

DESC

public static final SqlOrder DESC

Method Details

values

public static SqlOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SqlOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

from

public static SqlOrder from(String value)

Given a string value, return a SqlOrder, ignoring case and leading/trailing whitespace.

Parameters:

value - the value to convert from

Returns:

the SqlOrder enum corresponding to the given value

Throws:

IllegalArgumentException - if an invalid value is provided that does not map to a SqlOrder enum constant

searchWith

public <T> List<T> searchWith(Supplier<List<T>> ascSearch,
 Supplier<List<T>> descSearch)

Perform a search in either ascending or descending order using the given Supplier instances. If this instance is ASC then the ascending search is executed, otherwise if DESC the descending search is executed.

Type Parameters:

T - the result type

Parameters:

ascSearch - the logic to perform an ascending search

descSearch - the logic to perform a descending search

Returns:

a list of results in either ascending or descending order based on this instance

toSql

public String toSql()

Return a string that can be used directly in a SQL ORDER BY clause.

Returns:

a string that can be used in a SQL query