freemarker.template.expression
Class Dot

java.lang.Object
  |
  +--freemarker.template.expression.Dot
All Implemented Interfaces:
Expression, ExpressionElement, Operator, java.io.Serializable, Unary, Variable

public final class Dot
extends java.lang.Object
implements Unary, Variable, java.io.Serializable

The dot operator. Used to reference items inside a TemplateHashModel. It associates with other Variable expressions to its left.

Version:
$Id: Dot.java,v 1.28 2003/11/27 11:36:45 run2000 Exp $
See Also:
Serialized Form

Fields inherited from interface freemarker.template.expression.Unary
POSTFIX, PREFIX
 
Constructor Summary
Dot(Identifier id)
          Create a new Dot instruction.
 
Method Summary
 boolean equals(java.lang.Object o)
          Determines whether this object is equal to the given object.
 int getAssociationType()
          Retrieve the operator association for this operator.
 TemplateModel getAsTemplateModel(TemplateModelRoot modelRoot)
          The TemplateModel value of this Expression.
 java.lang.String getName(TemplateModelRoot modelRoot)
          Retrieve the name of this portion of the variable.
 int getOperatorClass()
          Return the type of operator this is to the caller.
 int getType()
          Determine the type of result that can be calculated by this expression.
 int hashCode()
          Returns the hash code for this operator.
 boolean isComplete()
          Are both the target and the identifier specified?
 void setTarget(Expression target)
          Sets the target of this Dot operator.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Dot

public Dot(Identifier id)
Create a new Dot instruction.
Parameters:
id - the identifier to the right of the dot.
Throws:
NullPointerException - the identifier is null
Method Detail

getName

public java.lang.String getName(TemplateModelRoot modelRoot)
Retrieve the name of this portion of the variable.
Specified by:
getName in interface Variable
Parameters:
modelRoot - the model to be used in cases where the variable is the result of an Expression.

isComplete

public boolean isComplete()
Are both the target and the identifier specified?
Specified by:
isComplete in interface Expression
Returns:
true if the target and identifier are both specified, otherwise false

getType

public int getType()
Determine the type of result that can be calculated by this expression. This is in the form of an integer constant ored together from values in the ExpressionUtils class.
Specified by:
getType in interface Expression

getAsTemplateModel

public TemplateModel getAsTemplateModel(TemplateModelRoot modelRoot)
                                 throws TemplateException
The TemplateModel value of this Expression.
Specified by:
getAsTemplateModel in interface Expression
Parameters:
modelRoot - the template model that will be evaluated by the expression
Throws:
TemplateException - the expression could not be evaluated for some reason

getAssociationType

public int getAssociationType()
Retrieve the operator association for this operator.
Specified by:
getAssociationType in interface Unary
Returns:
POSTFIX.

setTarget

public void setTarget(Expression target)
Sets the target of this Dot operator.
Specified by:
setTarget in interface Unary
Throws:
java.lang.IllegalArgumentException - the target is of the wrong type for this operator.

getOperatorClass

public int getOperatorClass()
Return the type of operator this is to the caller. Used for associating operators according to precedence.
Specified by:
getOperatorClass in interface Operator
Returns:
an integer indicating the type of operator this is

toString

public java.lang.String toString()
Returns a string representation of the object.
Overrides:
toString in class java.lang.Object
Returns:
a String representation of this expression

equals

public boolean equals(java.lang.Object o)
Determines whether this object is equal to the given object.
Overrides:
equals in class java.lang.Object
Parameters:
o - the object to be compared with
Returns:
true if the objects are equal, otherwise false

hashCode

public int hashCode()
Returns the hash code for this operator.
Overrides:
hashCode in class java.lang.Object
Returns:
the hash code of this object