org.jooq

Enum Comparator

java.lang.Object

java.lang.Enum<Comparator>

org.jooq.Comparator

All Implemented Interfaces:

Serializable, Comparable<Comparator>

public enum Comparator
extends Enum<Comparator>

A comparator to be used in conditions to form comparison predicates.

Comparison operators listed here can be used to compare Field or Row values with other Field or Row values, or with Select or QuantifiedSelect values.

The following flags indicate whether the comparator can be used as:

• a quantified comparison operator: supportsQuantifier(). Example: X = ANY (A, B, C)
• a subselect comparison operator: supportsSubselect(). Example: X = (SELECT A)

Author:

Lukas Eder

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUALS
GREATER
GREATER_OR_EQUAL
IN
IS_DISTINCT_FROM
IS_NOT_DISTINCT_FROM
LESS
LESS_OR_EQUAL
LIKE
LIKE_IGNORE_CASE
NOT_EQUALS
NOT_IN
NOT_LIKE
NOT_LIKE_IGNORE_CASE
NOT_SIMILAR_TO
SIMILAR_TO

Method Summary

Modifier and Type	Method and Description
Comparator	inverse() Get the inverse comparator such that A [op] B and NOT(A [inverse op] B).
Comparator	mirror() Get the mirrored comparator such that A [op] B and B [mirrored op] A, or null if the comparator cannot be mirrored.
boolean	supportsQuantifier() Deprecated. - 3.14.0 - [#9911] - This method is no longer supported.
boolean	supportsSubselect() Deprecated. - 3.14.0 - [#9911] - This method is no longer supported.
Keyword	toKeyword() A keyword rendition of this comparator.
String	toSQL() A SQL rendition of this comparator.
static Comparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static Comparator[]	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

Enum Constant Detail

IN

@NotNull
 @Support
public static final Comparator IN

NOT_IN

@NotNull
 @Support
public static final Comparator NOT_IN

EQUALS

@NotNull
 @Support
public static final Comparator EQUALS

NOT_EQUALS

@NotNull
 @Support
public static final Comparator NOT_EQUALS

LESS

@NotNull
 @Support
public static final Comparator LESS

LESS_OR_EQUAL

@NotNull
 @Support
public static final Comparator LESS_OR_EQUAL

GREATER

@NotNull
 @Support
public static final Comparator GREATER

GREATER_OR_EQUAL

@NotNull
 @Support
public static final Comparator GREATER_OR_EQUAL

IS_DISTINCT_FROM

@NotNull
 @Support
public static final Comparator IS_DISTINCT_FROM

IS_NOT_DISTINCT_FROM

@NotNull
 @Support
public static final Comparator IS_NOT_DISTINCT_FROM

LIKE

@NotNull
 @Support
public static final Comparator LIKE

NOT_LIKE

@NotNull
 @Support
public static final Comparator NOT_LIKE

SIMILAR_TO

@NotNull
 @Support(value={FIREBIRD,POSTGRES})
public static final Comparator SIMILAR_TO

NOT_SIMILAR_TO

@NotNull
 @Support(value={FIREBIRD,POSTGRES})
public static final Comparator NOT_SIMILAR_TO

LIKE_IGNORE_CASE

@NotNull
 @Support
public static final Comparator LIKE_IGNORE_CASE

NOT_LIKE_IGNORE_CASE

@NotNull
 @Support
public static final Comparator NOT_LIKE_IGNORE_CASE

Method Detail

values

public static Comparator[] 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 (Comparator c : Comparator.values())
    System.out.println(c);

Returns:

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

valueOf

public static Comparator 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

toSQL

public String toSQL()

A SQL rendition of this comparator.

toKeyword

public Keyword toKeyword()

A keyword rendition of this comparator.

inverse

public Comparator inverse()

Get the inverse comparator such that A [op] B and NOT(A [inverse op] B).

mirror

public Comparator mirror()

Get the mirrored comparator such that A [op] B and B [mirrored op] A, or null if the comparator cannot be mirrored.

supportsQuantifier

@Deprecated
public boolean supportsQuantifier()

Deprecated. - 3.14.0 - [#9911] - This method is no longer supported.

Whether this comparator supports quantifiers on the right-hand side.

supportsSubselect

@Deprecated
public boolean supportsSubselect()

Deprecated. - 3.14.0 - [#9911] - This method is no longer supported.

Whether this comparator supports subselects on the right-hand side.