com.atlassian.query.operand
Class FunctionOperand

java.lang.Object
  extended by com.atlassian.query.operand.FunctionOperand
All Implemented Interfaces:
Operand

public class FunctionOperand
extends java.lang.Object
implements Operand

Represents a function in the query tree.

Since:
v4.0

Constructor Summary
FunctionOperand(java.lang.String name)
           
FunctionOperand(java.lang.String name, java.util.Collection<java.lang.String> args)
           
FunctionOperand(java.lang.String name, java.lang.String... args)
           
 
Method Summary
<R> R
accept(OperandVisitor<R> visitor)
          Allows us to perform operations over the operand based on the passed in visitor.
 boolean equals(java.lang.Object o)
           
 java.util.List<java.lang.String> getArgs()
           
 java.lang.String getDisplayString()
          Renders the function call with its name and arguments for display in the UI.
 java.lang.String getName()
          The name that represents this Operand.
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunctionOperand

public FunctionOperand(java.lang.String name)

FunctionOperand

public FunctionOperand(java.lang.String name,
                       java.lang.String... args)

FunctionOperand

public FunctionOperand(java.lang.String name,
                       java.util.Collection<java.lang.String> args)
Method Detail

getName

public java.lang.String getName()
Description copied from interface: Operand
The name that represents this Operand.

Specified by:
getName in interface 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

public java.lang.String getDisplayString()
Renders the function call with its name and arguments for display in the UI.

Specified by:
getDisplayString in interface Operand
Returns:
something that looks like this: shear(sheep, goats).

accept

public <R> R accept(OperandVisitor<R> visitor)
Description copied from interface: Operand
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.

Specified by:
accept in interface Operand
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.

getArgs

public java.util.List<java.lang.String> getArgs()

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


Copyright © 2002-2010 Atlassian. All Rights Reserved.