net.sourceforge.jeval.function.math
Class ToRadians

java.lang.Object
  extended by net.sourceforge.jeval.function.math.ToRadians
All Implemented Interfaces:
Function

public class ToRadians
extends java.lang.Object
implements Function

This class is a function that executes within Evaluator. The function converts an angle measured in degress to the equivalent angle measured in radians. See the Math.toRadians(double) method in the JDK for a complete description of how this function works.


Constructor Summary
ToRadians()
           
 
Method Summary
 java.lang.String execute(Evaluator evaluator, java.lang.String arguments)
          Executes the function for the specified argument.
 java.lang.String getName()
          Returns the name of the function - "toRadians".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToRadians

public ToRadians()
Method Detail

getName

public java.lang.String getName()
Returns the name of the function - "toRadians".

Specified by:
getName in interface Function
Returns:
The name of this function class.

execute

public java.lang.String execute(Evaluator evaluator,
                                java.lang.String arguments)
                         throws FunctionException
Executes the function for the specified argument. This method is called internally by Evaluator.

Specified by:
execute in interface Function
Parameters:
evaluator - An instance of Evaluator.
arguments - A string argument that will be converted to a double value and evaluated.
Returns:
A measurement of the argument in radians.
Throws:
FunctionException - Thrown if the argument(s) are not valid for this function.


Copyright (C) 2002-2007 Robert Breidecker.