cz.jirutka.rsql.parser.ast

Class ComparisonNode

java.lang.Object

cz.jirutka.rsql.parser.ast.AbstractNode

cz.jirutka.rsql.parser.ast.ComparisonNode

All Implemented Interfaces:

Node

@Immutable
public final class ComparisonNode
extends AbstractNode

This node represents a comparison with operator, selector and arguments, e.g. name=in=(Jimmy,James).

Constructor Summary

Constructors

Constructor and Description
ComparisonNode(ComparisonOperator operator, java.lang.String selector, ComparisonArguments arguments)
ComparisonNode(ComparisonOperator operator, java.lang.String selector, java.util.List<java.lang.String> arguments) Deprecated. Use ComparisonNode(ComparisonOperator, String, ComparisonArguments)

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(RSQLVisitor<R,A> visitor, A param) Accepts the visitor, calls its visit() method and returns a result.
boolean	equals(java.lang.Object o)
java.util.List<java.lang.String>	getArguments() Deprecated. Use getArgumentsObject()
ComparisonArguments	getArgumentsObject() Return arguments.
ComparisonOperator	getOperator()
java.lang.String	getSelector()
int	hashCode()
java.lang.String	toString()
ComparisonNode	withArguments(ComparisonArguments newArguments) Returns a copy of this node with the specified arguments.
ComparisonNode	withArguments(java.util.List<java.lang.String> newArguments) Returns a copy of this node with the specified arguments.
ComparisonNode	withOperator(ComparisonOperator newOperator) Returns a copy of this node with the specified operator.
ComparisonNode	withSelector(java.lang.String newSelector) Returns a copy of this node with the specified selector.

Methods inherited from class cz.jirutka.rsql.parser.ast.AbstractNode

accept, getNestingLevel, setNestingLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparisonNode

public ComparisonNode(ComparisonOperator operator,
                      java.lang.String selector,
                      ComparisonArguments arguments)

Parameters:

operator - Must not be null.

selector - Must not be null or blank.

arguments - Must not be null or empty.

Throws:

java.lang.IllegalArgumentException - If one of the conditions specified above it not met.

Since:

2.4

ComparisonNode

@Deprecated
public ComparisonNode(ComparisonOperator operator,
                                  java.lang.String selector,
                                  java.util.List<java.lang.String> arguments)

Deprecated. Use ComparisonNode(ComparisonOperator, String, ComparisonArguments)

Parameters:

operator - Must not be null.

selector - Must not be null or blank.

arguments - Must not be null or empty. If the operator is not multiValue, then it must contain exactly one argument.

Throws:

java.lang.IllegalArgumentException - If one of the conditions specified above it not met.

Method Detail

accept

public <R,A> R accept(RSQLVisitor<R,A> visitor,
                      A param)

Description copied from interface: Node

Accepts the visitor, calls its visit() method and returns a result.

Each implementation must implement this methods exactly as listed:

 public <R, A> R accept(RSQLVisitor<R, A> visitor, A param) {
     return visitor.visit(this, param);
 }
 

Type Parameters:

R - Return type of the visitor's method.

A - Type of an optional parameter passed to the visitor's method.

Parameters:

visitor - The visitor whose appropriate method will be called.

param - An optional parameter to pass to the visitor.

Returns:

An object returned by the visitor (may be null).

getOperator

public ComparisonOperator getOperator()

withOperator

public ComparisonNode withOperator(ComparisonOperator newOperator)

Returns a copy of this node with the specified operator.

Parameters:

newOperator - Must not be null.

Returns:

a copy of this node with the specified operator.

getSelector

public java.lang.String getSelector()

withSelector

public ComparisonNode withSelector(java.lang.String newSelector)

Returns a copy of this node with the specified selector.

Parameters:

newSelector - Must not be null or blank.

Returns:

a copy of this node with the specified selector.

getArgumentsObject

public ComparisonArguments getArgumentsObject()

Return arguments. It's guaranteed that string arguments contains at least one item. When the operator is not multiValue, then it contains exactly one argument.

Returns:

the arguments.

getArguments

@Deprecated
public java.util.List<java.lang.String> getArguments()

Deprecated. Use getArgumentsObject()

Returns a copy of the arguments list. It's guaranteed that it contains at least one item. When the operator is not multiValue, then it contains exactly one argument.

Returns:

a copy of the arguments list.

withArguments

public ComparisonNode withArguments(ComparisonArguments newArguments)

Returns a copy of this node with the specified arguments.

Parameters:

newArguments - Must not be null or empty. If the operator is not multiValue, then it must contain exactly one argument.

Returns:

a copy of this node with the specified arguments.

withArguments

public ComparisonNode withArguments(java.util.List<java.lang.String> newArguments)

Returns a copy of this node with the specified arguments.

Parameters:

newArguments - Must not be null or empty. If the operator is not multiValue, then it must contain exactly one argument.

Returns:

a copy of this node with the specified arguments.

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