Package org.eclipse.wst.xml.xpath2.api

org.eclipse.wst.xml.xpath2.api
Class Function


public class Function
extends
Support for functions.

Method Summary

public booleancanMatchArity(int actualArity)
     Checks if this function has an to the
public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinitioncomputeReturnType(java.util.Collection args , org.eclipse.wst.xml.xpath2.api.StaticContext sc)
     Evaluate the exact result type.
public org.eclipse.wst.xml.xpath2.api.ResultSequenceevaluate(java.util.Collection args , org.eclipse.wst.xml.xpath2.api.EvaluationContext evaluationContext)
     Evaluate arguments.
public java.lang.StringgetArgumentNameHint(int index)
     Name hint for the index'th argument, starting at 0.
public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinitiongetArgumentType(int index)
     Returns the type of the argument at position index, starting at 0.
public intgetMaxArity()
     Maximum number of allowed arguments.
public intgetMinArity()
     Minimal number of allowed arguments.
public java.lang.StringgetName()
     Support for QName interface.
public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinitiongetResultType()
     Gets the return type for the function.
public booleanisVariableArgument()
     Maximum number of allowed arguments.

Methods Detail

canMatchArity

public boolean canMatchArity(int actualArity)

Checks if this function has an to the

Parameters

actualArity

Returns

boolean

computeReturnType

public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition computeReturnType(java.util.Collection args , org.eclipse.wst.xml.xpath2.api.StaticContext sc)

Evaluate the exact result type.

Parameters

args - argument expressions.

sc

Returns

org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition - Result of evaluation.

evaluate

public org.eclipse.wst.xml.xpath2.api.ResultSequence evaluate(java.util.Collection args , org.eclipse.wst.xml.xpath2.api.EvaluationContext evaluationContext)

Evaluate arguments.

Parameters

args - argument expressions.

evaluationContext

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - Result of evaluation.

getArgumentNameHint

public java.lang.String getArgumentNameHint(int index)

Name hint for the index'th argument, starting at 0.

Parameters

index

Returns

java.lang.String - TypeDefinition for the argument

getArgumentType

public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition getArgumentType(int index)

Returns the type of the argument at position index, starting at 0.

Parameters

index

Returns

org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition - TypeDefinition for the argument

getMaxArity

public int getMaxArity()

Maximum number of allowed arguments.

Returns

int - The highest number of arguments possible

getMinArity

public int getMinArity()

Minimal number of allowed arguments.

Returns

int - The smallest number of arguments possible

getName

public java.lang.String getName()

Support for QName interface.

Returns

java.lang.String - Result of QName operation.

getResultType

public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition getResultType()

Gets the return type for the function.

Returns

org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition - TypeDefinition for the argument

isVariableArgument

public boolean isVariableArgument()

Maximum number of allowed arguments.

Returns

boolean - The highest number of arguments possible