|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jext.dawn.Function
The Function
class defines the standard framework of any
Dawn function. A function is defined by its name, the one which will
be used to call it from scripts. The function also provides an
invoke()
method which can throw a DawnRuntimeException
on error.
Constructor Summary | |
Function()
Creates a new Dawn function, unnamed. |
|
Function(java.lang.String name)
Creates a new Dawn function. |
Method Summary | |
java.lang.String |
getHelp()
Returns the help associated with this function. |
java.lang.String |
getName()
Returns the function name. |
void |
invoke(DawnParser parser)
Executes the function. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Function()
public Function(java.lang.String name)
name
- The function nameMethod Detail |
public java.lang.String getHelp()
public java.lang.String getName()
String
, containing the namepublic void invoke(DawnParser parser) throws DawnRuntimeException
DawnParser
given as parameter.
parser
- The DawnParser
which inoked the function
A
- DawnRuntimeException
if an error occures
DawnRuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |