blob: b8bdabc0ed1d8977715ab09c479c4c64ef2859c6 [file] [log] [blame]
<html><body><p><font size="+1"><strong>Package org.eclipse.wst.xsl.debugger</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xsl.debugger</strong></font><br>
Class Variable</h2><br><hr><pre>public class <strong>Variable</strong>
extends java.lang.Object</pre>An abstract class that XSL processor implementations can subclass for their variables.<p></p><hr><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Field Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_BOOLEAN">BOOLEAN</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>public static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_GLOBAL_SCOPE">GLOBAL_SCOPE</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
The constant denoting a global scope variable.</td></tr><tr valign="top"><td width="20%" align="right"><code>public static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_LOCAL_SCOPE">LOCAL_SCOPE</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
The constant denoting a local scope variable.</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static int</code></td><td width="80%" align="left"><code><a href="#field_MAXIMUM_VALUE_SIZE">MAXIMUM_VALUE_SIZE</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_name">name</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_NODESET">NODESET</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_NUMBER">NUMBER</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_OBJECT">OBJECT</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_scope">scope</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected int</code></td><td width="80%" align="left"><code><a href="#field_slotNumber">slotNumber</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_STRING">STRING</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>public static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_TUNNEL_SCOPE">TUNNEL_SCOPE</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
The constant denoting a tunnel scope variable.</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_UNKNOWN">UNKNOWN</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>protected static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_UNRESOLVED">UNRESOLVED</a></code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr></table><br><table width="100%" border="1"><tr bgcolor="#CCCCFF"><td width="100%"><h2>Constructor Summary</h2></td></tr><tr><td><code><strong><a href="#con_Variable">Variable</a></strong>(java.lang.String name
,
java.lang.String scope
,
int slotNumber)</code></td></tr></table><br><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Method Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_equals">equals</a>(java.lang.Object obj)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_getId">getId</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the id used for this.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getName">getName</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the variable name.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getScope">getScope</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the scope of this variable - one of <code>LOCAL_SCOPE</code>, <code>TUNNEL_SCOPE</code> or <code>GLOBAL_SCOPE</code>.</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_getSlotNumber">getSlotNumber</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the slot number for this.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getType">getType</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the type of this variable e.g. string, or node</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getValue">getValue</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the current value of this variable as a String.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getValueFirstLine">getValueFirstLine</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Get the first line of the value truncating to <code>MAXIMUM_VALUE_SIZE</code> where necessary.</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_hashCode">hashCode</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
Field Detail
</h2></td></tr></table><h2><a name="field_BOOLEAN">BOOLEAN</a></h2><p><code>protected static java.lang.String <strong>BOOLEAN</strong></code></p><hr><h2><a name="field_GLOBAL_SCOPE">GLOBAL_SCOPE</a></h2><p><code>public static java.lang.String <strong>GLOBAL_SCOPE</strong></code></p><table><tr><td>The constant denoting a global scope variable.</td></tr></table><hr><h2><a name="field_LOCAL_SCOPE">LOCAL_SCOPE</a></h2><p><code>public static java.lang.String <strong>LOCAL_SCOPE</strong></code></p><table><tr><td>The constant denoting a local scope variable.</td></tr></table><hr><h2><a name="field_MAXIMUM_VALUE_SIZE">MAXIMUM_VALUE_SIZE</a></h2><p><code>protected static int <strong>MAXIMUM_VALUE_SIZE</strong></code></p><hr><h2><a name="field_name">name</a></h2><p><code>protected java.lang.String <strong>name</strong></code></p><hr><h2><a name="field_NODESET">NODESET</a></h2><p><code>protected static java.lang.String <strong>NODESET</strong></code></p><hr><h2><a name="field_NUMBER">NUMBER</a></h2><p><code>protected static java.lang.String <strong>NUMBER</strong></code></p><hr><h2><a name="field_OBJECT">OBJECT</a></h2><p><code>protected static java.lang.String <strong>OBJECT</strong></code></p><hr><h2><a name="field_scope">scope</a></h2><p><code>protected java.lang.String <strong>scope</strong></code></p><hr><h2><a name="field_slotNumber">slotNumber</a></h2><p><code>protected int <strong>slotNumber</strong></code></p><hr><h2><a name="field_STRING">STRING</a></h2><p><code>protected static java.lang.String <strong>STRING</strong></code></p><hr><h2><a name="field_TUNNEL_SCOPE">TUNNEL_SCOPE</a></h2><p><code>public static java.lang.String <strong>TUNNEL_SCOPE</strong></code></p><table><tr><td>The constant denoting a tunnel scope variable.</td></tr></table><hr><h2><a name="field_UNKNOWN">UNKNOWN</a></h2><p><code>protected static java.lang.String <strong>UNKNOWN</strong></code></p><hr><h2><a name="field_UNRESOLVED">UNRESOLVED</a></h2><p><code>protected static java.lang.String <strong>UNRESOLVED</strong></code></p><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
Constructor Detail
</h2></td></tr></table><h2><a name="con_Variable">Variable</a></h2><p><code>public <strong>Variable</strong>(java.lang.String name
,
java.lang.String scope
,
int slotNumber)</code></p><p>Create a new instance of this with the given name, scope and slot number.</p><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
Methods Detail
</h2></td></tr></table><h2><a name="method_equals">equals</a></h2><p><code>public boolean <strong>equals</strong>(java.lang.Object obj)</code></p><p></p><h3>Parameters</h3><p><code>obj</code></p><h3>Returns</h3><p><code>boolean</code></p><hr><h2><a name="method_getId">getId</a></h2><p><code>public int <strong>getId</strong>()</code></p><p>Get the id used for this.</p><h3>Returns</h3><p><code>int</code> - the variable id</p><hr><h2><a name="method_getName">getName</a></h2><p><code>public java.lang.String <strong>getName</strong>()</code></p><p>Get the variable name.</p><h3>Returns</h3><p><code>java.lang.String</code> - the variable name</p><hr><h2><a name="method_getScope">getScope</a></h2><p><code>public java.lang.String <strong>getScope</strong>()</code></p><p>Get the scope of this variable - one of <code>LOCAL_SCOPE</code>, <code>TUNNEL_SCOPE</code> or <code>GLOBAL_SCOPE</code>.</p><h3>Returns</h3><p><code>java.lang.String</code> - the variable scope</p><hr><h2><a name="method_getSlotNumber">getSlotNumber</a></h2><p><code>public int <strong>getSlotNumber</strong>()</code></p><p>Get the slot number for this.</p><h3>Returns</h3><p><code>int</code> - the slot number</p><hr><h2><a name="method_getType">getType</a></h2><p><code>public java.lang.String <strong>getType</strong>()</code></p><p>Get the type of this variable e.g. string, or node</p><h3>Returns</h3><p><code>java.lang.String</code> - the variable type</p><hr><h2><a name="method_getValue">getValue</a></h2><p><code>public java.lang.String <strong>getValue</strong>()</code></p><p>Get the current value of this variable as a String.</p><h3>Returns</h3><p><code>java.lang.String</code> - the value of this</p><hr><h2><a name="method_getValueFirstLine">getValueFirstLine</a></h2><p><code>public java.lang.String <strong>getValueFirstLine</strong>()</code></p><p>Get the first line of the value truncating to <code>MAXIMUM_VALUE_SIZE</code> where necessary.</p><h3>Returns</h3><p><code>java.lang.String</code> - the first line of the value</p><hr><h2><a name="method_hashCode">hashCode</a></h2><p><code>public int <strong>hashCode</strong>()</code></p><p></p><h3>Returns</h3><p><code>int</code></p><hr></body></html>