org.apache.xalan.templates

Class FuncFormatNumb

java.lang.Object

org.apache.xpath.Expression

org.apache.xpath.functions.Function

org.apache.xpath.functions.FunctionOneArg

org.apache.xpath.functions.Function2Args

org.apache.xpath.functions.Function3Args

org.apache.xalan.templates.FuncFormatNumb

All Implemented Interfaces:

Serializable, SourceLocator, ExpressionNode, ExpressionOwner, XPathVisitable

public class FuncFormatNumb
extends Function3Args

Execute the FormatNumber() function.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FuncFormatNumb()

Method Summary

Modifier and Type	Method and Description
void	checkNumberArgs(int argNum) Overide the superclass method to allow one or two arguments.
XObject	execute(XPathContext xctxt) Execute the function.
protected void	reportWrongNumberArgs() Constructs and throws a WrongNumberArgException with the appropriate message for this function object.
void	warn(XPathContext xctxt, String msg, Object[] args) Warn the user of a problem.

Methods inherited from class org.apache.xpath.functions.Function3Args

callArgVisitors, canTraverseOutsideSubtree, deepEquals, fixupVariables, getArg2, setArg

Methods inherited from class org.apache.xpath.functions.Function2Args

getArg1

Methods inherited from class org.apache.xpath.functions.FunctionOneArg

getArg0, getExpression, setExpression

Methods inherited from class org.apache.xpath.functions.Function

callVisitors, postCompileStep

Methods inherited from class org.apache.xpath.Expression

asIterator, asIteratorRaw, asNode, assertion, bool, error, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isSameClass, isStableNumber, num, xstr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FuncFormatNumb

public FuncFormatNumb()

Method Detail

execute

public XObject execute(XPathContext xctxt)
                throws TransformerException

Execute the function. The function must return a valid object.

Overrides:

execute in class Function

Parameters:

xctxt - The current execution context.

Returns:

A valid XObject.

Throws:

TransformerException

warn

public void warn(XPathContext xctxt,
                 String msg,
                 Object[] args)
          throws TransformerException

Warn the user of a problem.

Overrides:

warn in class Expression

Parameters:

xctxt - The XPath runtime state.

msg - Warning message key

args - Arguments to be used in warning message

Throws:

XSLProcessorException - thrown if the active ProblemListener and XPathContext decide the error condition is severe enough to halt processing.

TransformerException

checkNumberArgs

public void checkNumberArgs(int argNum)
                     throws WrongNumberArgsException

Overide the superclass method to allow one or two arguments.

Overrides:

checkNumberArgs in class Function3Args

Parameters:

argNum - Number of arguments passed in

Throws:

WrongNumberArgsException

reportWrongNumberArgs

protected void reportWrongNumberArgs()
                              throws WrongNumberArgsException

Constructs and throws a WrongNumberArgException with the appropriate message for this function object.

Overrides:

reportWrongNumberArgs in class Function3Args

Throws:

WrongNumberArgsException