com.atlassian.query.operand

Interface Operand

All Known Implementing Classes:

EmptyOperand, FunctionOperand, MultiValueOperand, SingleValueOperand

public interface Operand

Represents the right hand side value of a clause.

Since:

v4.0

Method Summary

Methods

Modifier and Type	Method and Description
<R> R	accept(OperandVisitor<R> visitor) Allows us to perform operations over the operand based on the passed in visitor.
String	getDisplayString() Produces the unexpanded representation of the Operand.
String	getName() The name that represents this Operand.

Method Detail

getName

String getName()

The name that represents this Operand.

Returns:

the name of the operand, null if the operand is unnamed. If an operand is unnamed then it likely represents literal values (such as Strings or Longs).

getDisplayString

String getDisplayString()

Produces the unexpanded representation of the Operand. In the case of a function operand this would be the function as represented in the Query (i.e. group(jira-users)).

Returns:

a string that represents this operand as represented in the JQL query string.

accept

<R> R accept(OperandVisitor<R> visitor)

Allows us to perform operations over the operand based on the passed in visitor. This method calls the visit method on the visitor with this reference.

Type Parameters:

R - the return type for the visitor.

Parameters:

visitor - the visitor to accept.

Returns:

the result of the visit operation who's type is specified by the incomming visitor.