freemarker.template
Class SimpleNumber

java.lang.Object
  |
  +--freemarker.template.compiler.TemplateObject
        |
        +--freemarker.template.compiler.Expression
              |
              +--freemarker.template.SimpleNumber
All Implemented Interfaces:
java.io.Serializable, TemplateModel, TemplateNumberModel, TemplateScalarModel

public final class SimpleNumber
extends Expression
implements TemplateNumberModel, java.io.Serializable

A simple implementation of the TemplateNumberModel interface. Note that this class is immutable.

Author:
Jonathan Revusky
See Also:
Serialized Form

Constructor Summary
SimpleNumber(int val)
           
SimpleNumber(java.lang.Number value)
           
SimpleNumber(java.lang.Number value, java.util.Locale locale)
           
SimpleNumber(java.lang.Number value, java.text.NumberFormat format)
           
 
Method Summary
 java.lang.Number getAsNumber()
          Returns the number.
 java.lang.String getAsString(java.util.Locale loc)
          We use the locale to figure out the decimal separator to use.
 TemplateModel getAsTemplateModel(TemplateModelRoot modelRoot)
           
 java.lang.String getName()
           
 java.lang.Number getNumericalValue(TemplateModelRoot modelRoot)
           
 java.lang.String getStringValue(TemplateModelRoot modelRoot)
           
 boolean isEmpty()
           
 boolean isNumerical(TemplateModelRoot modelRoot)
          always returns true.
 boolean isTrue(TemplateModelRoot modelRoot)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimpleNumber

public SimpleNumber(java.lang.Number value)

SimpleNumber

public SimpleNumber(java.lang.Number value,
                    java.text.NumberFormat format)

SimpleNumber

public SimpleNumber(java.lang.Number value,
                    java.util.Locale locale)

SimpleNumber

public SimpleNumber(int val)
Method Detail

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface TemplateModel
Following copied from interface: freemarker.template.TemplateModel
Returns:
true if this object is empty.

getAsNumber

public java.lang.Number getAsNumber()
Description copied from interface: TemplateNumberModel
Returns the number.
Specified by:
getAsNumber in interface TemplateNumberModel
Following copied from interface: freemarker.template.TemplateNumberModel
Returns:
the java.lang.Number instance associated with this scalar.

getAsString

public java.lang.String getAsString(java.util.Locale loc)
We use the locale to figure out the decimal separator to use.
Specified by:
getAsString in interface TemplateScalarModel

getStringValue

public java.lang.String getStringValue(TemplateModelRoot modelRoot)
Overrides:
getStringValue in class Expression

getNumericalValue

public java.lang.Number getNumericalValue(TemplateModelRoot modelRoot)

getAsTemplateModel

public TemplateModel getAsTemplateModel(TemplateModelRoot modelRoot)
Overrides:
getAsTemplateModel in class Expression

isTrue

public boolean isTrue(TemplateModelRoot modelRoot)
Overrides:
isTrue in class Expression

isNumerical

public boolean isNumerical(TemplateModelRoot modelRoot)
always returns true.

getName

public java.lang.String getName()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object