fscript.html

一个j2me的脚本引擎

addLines</H3>
<PRE>
public void <B>addLines</B>(java.lang.String&nbsp;s)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="runCode()"><!-- --></A><H3>
runCode</H3>
<PRE>
public java.lang.Object <B>runCode</B>()
                         throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Run the parser over currently loaded code
<P>
<DD><DL>

<DT><B>Returns:</B><DD>any return value of the script's execution (will be one of 
FScript's supported type objects, Integer,String)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public void <B>reset</B>()</PRE>
<DL>
<DD>Resets the internal code store
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="exit(java.lang.Object)"><!-- --></A><H3>
exit</H3>
<PRE>
public void <B>exit</B>(java.lang.Object&nbsp;o)
          throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Forces an exit from the currently running script 
 equivalent of 'exit' keyword in FScriptME itself.
 intended to be called from within functions implemented in FScript 
 subclasses
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>o,</CODE> - object that will be returned from the entry point (runCode or cont)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="cont()"><!-- --></A><H3>
cont</H3>
<PRE>
public java.lang.Object <B>cont</B>()
                      throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Continues execution from current point - only really
 useful in a document processing application where you may
 wish to add code, execute, add some more code..etc..
<P>
<DD><DL>

<DT><B>Returns:</B><DD>any return value of the script's execution (will be one of 
FScript's supported type objects, Integer,String)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getError()"><!-- --></A><H3>
getError</H3>
<PRE>
public java.lang.String[] <B>getError</B>()</PRE>
<DL>
<DD>Returns more details on any error states, indicated by
 FSExceptions.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>String, see below <br>
 s[0]=the error text <BR>
 s[1]=the line number <BR>
 s[2]=the line text <BR>
 s[3]=the current token <BR>
 s[4]=a variable dump (current scope) <BR>
 s[5]=a global variable dump (only if currnent scope is not global <BR></DL>
</DD>
</DL>
<HR>

<A NAME="getVar(java.lang.String)"><!-- --></A><H3>
getVar</H3>
<PRE>
protected java.lang.Object <B>getVar</B>(java.lang.String&nbsp;name)
                           throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Override this method to allow external access to variables
 in your code.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name,</CODE> - the name of the variable the parser is requesting
 e.g
 add this...
 <br>
 if (name.equals("one") { return new Integer(1) }
 <br>
 to allow the code
 <br>
 a=one
 <br>
 to work in FScript
<DT><B>Returns:</B><DD>Object - currently expected to be String or Integer
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getVar(java.lang.String, java.lang.Object)"><!-- --></A><H3>
getVar</H3>
<PRE>
protected java.lang.Object <B>getVar</B>(java.lang.String&nbsp;name,
                                  java.lang.Object&nbsp;index)
                           throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Override this method to allow external access to variables
 in your code.
<p>As getVar(String name) but allows an index variable to be
passed so code such as :
 name=list[2]
 is possible
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name,</CODE> - the name of the variable the parser is requesting
<DT><B>Returns:</B><DD>Object - currently expected to be String, Integer
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setVar(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setVar</H3>
<PRE>
protected void <B>setVar</B>(java.lang.String&nbsp;name,
                      java.lang.Object&nbsp;value)
               throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Logical inverse of getVar
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the variable name<DD><CODE>value</CODE> - the value to set it to
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setVar(java.lang.String, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
setVar</H3>
<PRE>
protected void <B>setVar</B>(java.lang.String&nbsp;name,
                      java.lang.Object&nbsp;index,
                      java.lang.Object&nbsp;value)
               throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Logical inverse of getVar (with index)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the variable name<DD><CODE>index</CODE> - the index into the 'array'<DD><CODE>value</CODE> - the value to set it to
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="callFunction(java.lang.String, java.util.Vector)"><!-- --></A><H3>
callFunction</H3>
<PRE>
protected java.lang.Object <B>callFunction</B>(java.lang.String&nbsp;name,
                                        java.util.Vector&nbsp;params)
                                 throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Override this call to implement custom functions
 See the BasicIO class for an example
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the function name<DD><CODE>params</CODE> - an ArrayList of parameter values
<DT><B>Returns:</B><DD>an Object, currently expected to be Integer or String
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setScriptVar(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setScriptVar</H3>
<PRE>
public final void <B>setScriptVar</B>(java.lang.String&nbsp;name,
                               java.lang.Object&nbsp;value)
                        throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Sets a variable in script space = the value passed in - the variable
must be have the correct type - note that if the varialble is not defined in the 
script, calls will be made to subclass setVar methods - therefore this method 
should be used with caution from within an overriden setVar.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the variable<DD><CODE>value</CODE> - the value to set variable to (String,Integer)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getScriptVar(java.lang.String)"><!-- --></A><H3>
getScriptVar</H3>
<PRE>
public final java.lang.Object <B>getScriptVar</B>(java.lang.String&nbsp;name)
                                    throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Gets a variable in script space note that if the varialble is not defined in the 
script, calls will be made to subclass getVar methods - therefore this method 
should be used with caution from within an overriden getVar.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the variable
<DT><B>Returns:</B><DD>the value of the variable (String,Integer)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="callScriptFunction(java.lang.String, java.util.Vector)"><!-- --></A><H3>
callScriptFunction</H3>
<PRE>
public final java.lang.Object <B>callScriptFunction</B>(java.lang.String&nbsp;name,
                                                 java.util.Vector&nbsp;params)
                                          throws <A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></PRE>
<DL>
<DD>Calls a function in the script - note that if the function is not defined calls
will be made to the subclass callFunction methods - therefore this method should
be used with caution from within an overriden callFunction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the function<DD><CODE>params</CODE> - the parameters to pass (must be correct type and number)
<DT><B>Returns:</B><DD>the return value of the function (String,Integer)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME">FSException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../murlen/util/fscriptME/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../murlen/util/fscriptME/FSException.html" title="class in murlen.util.fscriptME"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?murlen/util/fscriptME/FScript.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="FScript.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>