org.odftoolkit.odfdom.type

Class Formula

java.lang.Object

org.odftoolkit.odfdom.type.Formula

All Implemented Interfaces:

OdfDataType

public class Formula
extends Object
implements OdfDataType

This class represents the in OpenDocument format used data type formula

Constructor Summary

Constructors

Constructor and Description
Formula(String formula) Construct Formula by the parsing the given string

Method Summary

Modifier and Type	Method and Description
static boolean	isValid(String stringValue) check if the specified String is a valid formula data type
String	toString() Returns a String Object representing this Formula's value
static Formula	valueOf(String stringValue) Returns a Formula instance representing the specified String value

Methods inherited from class java.lang.Object

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

Constructor Detail

Formula

public Formula(String formula)
        throws IllegalArgumentException

Construct Formula by the parsing the given string

Parameters:

formula - The String to be parsed into Formula

Throws:

IllegalArgumentException - if the given argument is not a valid Formula

Method Detail

toString

public String toString()

Returns a String Object representing this Formula's value

Overrides:

toString in class Object

Returns:

return a string representation of the value of this Formula object

valueOf

public static Formula valueOf(String stringValue)
                       throws IllegalArgumentException

Returns a Formula instance representing the specified String value

Parameters:

stringValue - a String value

Returns:

return a Formula instance representing stringValue

Throws:

IllegalArgumentException - if the given argument is not a valid Formula

isValid

public static boolean isValid(String stringValue)

check if the specified String is a valid formula data type

Parameters:

stringValue - the value to be tested

Returns:

true if the value of argument is valid for formula data type false otherwise