org.exist.xquery
Class FunctionSignature
java.lang.Object
org.exist.xquery.FunctionSignature
public class FunctionSignature
- extends Object
Describes the signature of a built-in or user-defined function, i.e.
its name, the type and cardinality of its arguments and its return type.
- Author:
- wolf
Constructor Summary |
FunctionSignature(QName name)
|
FunctionSignature(QName name,
SequenceType[] arguments,
SequenceType returnType)
|
FunctionSignature(QName name,
SequenceType[] arguments,
SequenceType returnType,
boolean overloaded)
|
FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType)
|
FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType,
boolean overloaded)
Create a new function signature. |
FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType,
boolean overloaded,
String deprecated)
|
FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType,
String deprecated)
|
DEFAULT_TYPE
public static final SequenceType DEFAULT_TYPE
- Default sequence type for function parameters.
NO_ARGS
public static final SequenceType[] NO_ARGS
- Empty array to specify if a function doesn't take any arguments.
FunctionSignature
public FunctionSignature(QName name)
FunctionSignature
public FunctionSignature(QName name,
SequenceType[] arguments,
SequenceType returnType)
FunctionSignature
public FunctionSignature(QName name,
SequenceType[] arguments,
SequenceType returnType,
boolean overloaded)
FunctionSignature
public FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType)
FunctionSignature
public FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType,
String deprecated)
FunctionSignature
public FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType,
boolean overloaded,
String deprecated)
FunctionSignature
public FunctionSignature(QName name,
String description,
SequenceType[] arguments,
SequenceType returnType,
boolean overloaded)
- Create a new function signature.
- Parameters:
name
- the QName of the function.arguments
- the sequence types of all expected argumentsreturnType
- the sequence type returned by the functionoverloaded
- set to true if the function may expect additional parameters
singleArgument
public static final SequenceType[] singleArgument(SequenceType arg)
getName
public QName getName()
getArgumentCount
public int getArgumentCount()
getFunctionId
public FunctionId getFunctionId()
getReturnType
public SequenceType getReturnType()
setReturnType
public void setReturnType(SequenceType type)
getArgumentTypes
public SequenceType[] getArgumentTypes()
setArgumentTypes
public void setArgumentTypes(SequenceType[] types)
getDescription
public String getDescription()
isOverloaded
public boolean isOverloaded()
isDeprecated
public boolean isDeprecated()
getDeprecated
public String getDeprecated()
setDeprecated
public void setDeprecated(String message)
toString
public String toString()
- Overrides:
toString
in class Object
equals
public boolean equals(Object obj)
- Overrides:
equals
in class Object
Copyright (C) Wolfgang Meier. All rights reserved.