| <html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.api</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.api</strong></font><br> |
| Class Function</h2><br><hr><pre>public class <strong>Function</strong> |
| extends </pre>Support for functions.<p></p><hr><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_canMatchArity">canMatchArity</a>(int actualArity)</code><br> |
| |
| Checks if this function has an to the</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></td><td width="" align="left"><code><a href="#method_computeReturnType">computeReturnType</a>(java.util.Collection args |
| , |
| org.eclipse.wst.xml.xpath2.api.StaticContext sc)</code><br> |
| |
| Evaluate the exact result type.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_evaluate">evaluate</a>(java.util.Collection args |
| , |
| org.eclipse.wst.xml.xpath2.api.EvaluationContext evaluationContext)</code><br> |
| |
| Evaluate arguments.</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_getArgumentNameHint">getArgumentNameHint</a>(int index)</code><br> |
| |
| Name hint for the index'th argument, |
| starting at 0.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></td><td width="" align="left"><code><a href="#method_getArgumentType">getArgumentType</a>(int index)</code><br> |
| |
| Returns the type of the argument at position index, |
| starting at 0.</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_getMaxArity">getMaxArity</a>()</code><br> |
| |
| Maximum number of allowed arguments.</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_getMinArity">getMinArity</a>()</code><br> |
| |
| Minimal number of allowed arguments.</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> |
| |
| Support for QName interface.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></td><td width="" align="left"><code><a href="#method_getResultType">getResultType</a>()</code><br> |
| |
| Gets the return type for the function.</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_isVariableArgument">isVariableArgument</a>()</code><br> |
| |
| Maximum number of allowed arguments.</td></tr></table><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_canMatchArity">canMatchArity</a></h2><p><code>public boolean <strong>canMatchArity</strong>(int actualArity)</code></p><p>Checks if this function has an to the</p><h3>Parameters</h3><p><code>actualArity</code></p><h3>Returns</h3><p><code>boolean</code></p><hr><h2><a name="method_computeReturnType">computeReturnType</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition <strong>computeReturnType</strong>(java.util.Collection args |
| , |
| org.eclipse.wst.xml.xpath2.api.StaticContext sc)</code></p><p>Evaluate the exact result type.</p><h3>Parameters</h3><p><code>args</code> - argument expressions.</p><p><code>sc</code></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code> - Result of evaluation.</p><hr><h2><a name="method_evaluate">evaluate</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>evaluate</strong>(java.util.Collection args |
| , |
| org.eclipse.wst.xml.xpath2.api.EvaluationContext evaluationContext)</code></p><p>Evaluate arguments.</p><h3>Parameters</h3><p><code>args</code> - argument expressions.</p><p><code>evaluationContext</code></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - Result of evaluation.</p><hr><h2><a name="method_getArgumentNameHint">getArgumentNameHint</a></h2><p><code>public java.lang.String <strong>getArgumentNameHint</strong>(int index)</code></p><p>Name hint for the index'th argument, |
| starting at 0.</p><h3>Parameters</h3><p><code>index</code></p><h3>Returns</h3><p><code>java.lang.String</code> - TypeDefinition for the argument</p><hr><h2><a name="method_getArgumentType">getArgumentType</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition <strong>getArgumentType</strong>(int index)</code></p><p>Returns the type of the argument at position index, |
| starting at 0.</p><h3>Parameters</h3><p><code>index</code></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code> - TypeDefinition for the argument</p><hr><h2><a name="method_getMaxArity">getMaxArity</a></h2><p><code>public int <strong>getMaxArity</strong>()</code></p><p>Maximum number of allowed arguments.</p><h3>Returns</h3><p><code>int</code> - The highest number of arguments possible</p><hr><h2><a name="method_getMinArity">getMinArity</a></h2><p><code>public int <strong>getMinArity</strong>()</code></p><p>Minimal number of allowed arguments.</p><h3>Returns</h3><p><code>int</code> - The smallest number of arguments possible</p><hr><h2><a name="method_getName">getName</a></h2><p><code>public java.lang.String <strong>getName</strong>()</code></p><p>Support for QName interface.</p><h3>Returns</h3><p><code>java.lang.String</code> - Result of QName operation.</p><hr><h2><a name="method_getResultType">getResultType</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition <strong>getResultType</strong>()</code></p><p>Gets the return type for the function.</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code> - TypeDefinition for the argument</p><hr><h2><a name="method_isVariableArgument">isVariableArgument</a></h2><p><code>public boolean <strong>isVariableArgument</strong>()</code></p><p>Maximum number of allowed arguments.</p><h3>Returns</h3><p><code>boolean</code> - The highest number of arguments possible</p><hr></body></html> |
