cz.jirutka.rsql.parser.ast

Class ComparisonOperator

java.lang.Object

cz.jirutka.rsql.parser.ast.ComparisonOperator

@Immutable
public final class ComparisonOperator
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComparisonOperator.MultiValue
static class	ComparisonOperator.Nested
static class	ComparisonOperator.Type Defines the different types of arguments.

Field Summary

Fields

Modifier and Type	Field and Description
static ComparisonOperator.Type	MULTIARY_TYPE
static ComparisonOperator.Type	NESTED_TYPE
static ComparisonOperator.Type	NULLARY_TYPE
static ComparisonOperator.Type	UNARY_TYPE

Constructor Summary

Constructors

Constructor and Description
ComparisonOperator(java.lang.String... symbols)
ComparisonOperator(java.lang.String[] symbols, Arity arity) Deprecated. in favor of ComparisonOperator(String[], Type)
ComparisonOperator(java.lang.String[] symbols, boolean multiValue) Deprecated. in favor of ComparisonOperator(String[], Type)
ComparisonOperator(java.lang.String[] symbols, ComparisonOperator.Type type)
ComparisonOperator(java.lang.String symbol, Arity arity) Deprecated. in favor of ComparisonOperator(String, Type)
ComparisonOperator(java.lang.String symbol, boolean multiValue) Deprecated. in favor of ComparisonOperator(String, Type)
ComparisonOperator(java.lang.String symbol, ComparisonOperator.Type type)
ComparisonOperator(java.lang.String symbol, java.lang.String altSymbol, Arity arity)
ComparisonOperator(java.lang.String symbol, java.lang.String altSymbol, boolean multiValue) Deprecated. in favor of ComparisonOperator(String, String, Arity)
ComparisonOperator(java.lang.String symbol, java.lang.String altSymbol, ComparisonOperator.Type type)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Arity	getArity() Returns the arity of this operator.
java.lang.String	getSymbol() Returns the primary representation of this operator.
java.lang.String[]	getSymbols() Returns all representations of this operator.
ComparisonOperator.Type	getType() Returns the arguments type.
int	hashCode()
boolean	isMultiValue() Deprecated. use getArity()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NESTED_TYPE

public static final ComparisonOperator.Type NESTED_TYPE

NULLARY_TYPE

public static final ComparisonOperator.Type NULLARY_TYPE

UNARY_TYPE

public static final ComparisonOperator.Type UNARY_TYPE

MULTIARY_TYPE

public static final ComparisonOperator.Type MULTIARY_TYPE

Constructor Detail

ComparisonOperator

public ComparisonOperator(java.lang.String[] symbols,
                          ComparisonOperator.Type type)

Parameters:

symbols - Textual representation of this operator (e.g. =gt=); the first item is primary representation, any others are alternatives. Must match =[a-zA-Z]*=|[><]=?|!=.

type - Whether this operator may be used with single, multiple or nested arguments. This is then validated in NodesFactory.

Throws:

java.lang.IllegalArgumentException - If the symbols is either null, empty, or contain illegal symbols.

Since:

2.4.0

ComparisonOperator

public ComparisonOperator(java.lang.String symbol,
                          ComparisonOperator.Type type)

Parameters:

symbol - Textual representation of this operator (e.g. =gt=); Must match =[a-zA-Z]*=|[><]=?|!=.

type - Whether this operator may be used with single, multiple or nested arguments. This is then validated in NodesFactory.

Since:

2.4.0

See Also:

ComparisonOperator(String[], Type)

ComparisonOperator

public ComparisonOperator(java.lang.String symbol,
                          java.lang.String altSymbol,
                          ComparisonOperator.Type type)

Parameters:

symbol - Textual representation of this operator (e.g. =gt=); Must match =[a-zA-Z]*=|[><]=?|!=.

altSymbol - Alternative representation for symbol.

type - Whether this operator may be used with single, multiple or nested arguments.

Since:

2.4.0

See Also:

ComparisonOperator(String[], Type)

ComparisonOperator

@Deprecated
public ComparisonOperator(java.lang.String[] symbols,
                                      boolean multiValue)

Deprecated. in favor of ComparisonOperator(String[], Type)

Parameters:

symbols - Textual representation of this operator (e.g. =gt=); the first item is primary representation, any others are alternatives. Must match =[a-zA-Z]*=|[><]=?|!=.

multiValue - Whether this operator may be used with multiple arguments. This is then validated in NodesFactory.

Throws:

java.lang.IllegalArgumentException - If the symbols is either null, empty, or contain illegal symbols.

See Also:

ComparisonOperator(String[], Arity)

ComparisonOperator

@Deprecated
public ComparisonOperator(java.lang.String[] symbols,
                                      Arity arity)

Deprecated. in favor of ComparisonOperator(String[], Type)

Parameters:

symbols - Textual representation of this operator (e.g. =gt=); the first item is primary representation, any others are alternatives. Must match =[a-zA-Z]*=|[><]=?|!=.

arity - Arity of this operator.

Throws:

java.lang.IllegalArgumentException - If the symbols is either null, empty, or contain illegal symbols.

Since:

2.3.0

ComparisonOperator

@Deprecated
public ComparisonOperator(java.lang.String symbol,
                                      boolean multiValue)

Deprecated. in favor of ComparisonOperator(String, Type)

Parameters:

symbol - Textual representation of this operator (e.g. =gt=); Must match =[a-zA-Z]*=|[><]=?|!=.

multiValue - Whether this operator may be used with multiple arguments. This is then validated in NodesFactory.

See Also:

ComparisonOperator(String[], boolean)

ComparisonOperator

@Deprecated
public ComparisonOperator(java.lang.String symbol,
                                      Arity arity)

Deprecated. in favor of ComparisonOperator(String, Type)

Parameters:

symbol - Textual representation of this operator (e.g. =gt=); Must match =[a-zA-Z]*=|[><]=?|!=.

arity - Arity of this operator.

Since:

2.3.0

See Also:

ComparisonOperator(String[], boolean)

ComparisonOperator

@Deprecated
public ComparisonOperator(java.lang.String symbol,
                                      java.lang.String altSymbol,
                                      boolean multiValue)

Deprecated. in favor of ComparisonOperator(String, String, Arity)

Parameters:

symbol - Textual representation of this operator (e.g. =gt=); Must match =[a-zA-Z]*=|[><]=?|!=.

altSymbol - Alternative representation for symbol.

multiValue - Whether this operator may be used with multiple arguments. This is then

See Also:

ComparisonOperator(String[], boolean)

ComparisonOperator

public ComparisonOperator(java.lang.String symbol,
                          java.lang.String altSymbol,
                          Arity arity)

Parameters:

symbol - Textual representation of this operator (e.g. =gt=); Must match =[a-zA-Z]*=|[><]=?|!=.

altSymbol - Alternative representation for symbol.

arity - Arity of this operator.

Since:

2.3.0

See Also:

ComparisonOperator(String[], boolean)

ComparisonOperator

public ComparisonOperator(java.lang.String... symbols)

Parameters:

symbols - Textual representation of this operator (e.g. =gt=); the first item is primary representation, any others are alternatives. Must match =[a-zA-Z]*=|[><]=?|!=.

See Also:

ComparisonOperator(String[], Type)

Method Detail

getSymbol

public java.lang.String getSymbol()

Returns the primary representation of this operator.

Returns:

the primary representation of this operator.

getSymbols

public java.lang.String[] getSymbols()

Returns all representations of this operator. The first item is always the primary representation.

Returns:

all representations of this operator. The first item is always the primary representation.

isMultiValue

@Deprecated
public boolean isMultiValue()

Deprecated. use getArity()

Whether this operator may be used with multiple arguments.

Returns:

Whether this operator may be used with multiple arguments.

getArity

public Arity getArity()

Returns the arity of this operator.

Returns:

the arity of this operator.

Since:

2.3.0

getType

public ComparisonOperator.Type getType()

Returns the arguments type.

Returns:

arguments type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object