FuncType

java.lang.Object
- org.basex.query.item.FuncType

All Implemented Interfaces:

Type

Direct Known Subclasses:

MapType
```
public class FuncType
extends java.lang.Object
implements Type
```
XQuery 3.0 function data types.

Author:

BaseX Team 2005-12, BSD License, Leo Woerteler

Field Summary

Fields
Modifier and Type Field and Description

static FuncType ANY_FUN
Any function type.

SeqType[] args
Argument types.

SeqType ret
Return type.

Fields
Modifier and Type	Field and Description
`static FuncType`	`ANY_FUN` Any function type.
`SeqType[]`	`args` Argument types.
`SeqType`	`ret` Return type.

Method Summary

Methods
Modifier and Type	Method and Description
`static FuncType`	`arity(int a)` Getter for function types with a given arity.
`FItem`	`cast(Item it, QueryContext ctx, InputInfo ii)` Casts the specified item to the XQuery data type.
`Item`	`cast(java.lang.Object o, InputInfo ii)` Casts the specified Java object to the XQuery data type.
`static Type`	`find(QNm type)` Finds and returns the specified function type.
`static FuncType`	`get(SeqType ret, SeqType... args)` Getter for function types.
`static FuncType`	`get(UserFunc f)` Getter for a function's type.
`int`	`id()` Returns a type id to differentiate all types.
`boolean`	`instanceOf(Type t)` Checks if the current type is an instance of the specified type.
`boolean`	`isDate()` Checks if the type refers to a `date` or one of its sub-types.
`boolean`	`isDuration()` Checks if the type refers to a `xs:duration` or one of its sub-types.
`boolean`	`isFunction()` Checks if the type refers to a function item.
`boolean`	`isMap()` Checks if the type refers to a map.
`boolean`	`isNode()` Checks if the type refers to a node.
`boolean`	`isNumber()` Checks if the type refers to a number.
`boolean`	`isString()` Checks if the type refers to an `xs:string` or one of its sub-types.
`boolean`	`isUntyped()` Checks if the type refers to an untyped item.
`SeqType`	`seqType()` Returns the sequence type of this data type.
`byte[]`	`string()` Returns the string representation of this type.
`java.lang.String`	`toString()`
`Var[]`	`type(Var[] vars)` Sets the types of the given variables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ANY_FUN
```
public static final FuncType ANY_FUN
```
    Any function type.
  - args
```
public final SeqType[] args
```
    Argument types.
  - ret
```
public final SeqType ret
```
    Return type.
- Method Detail
  - isNode
```
public final boolean isNode()
```
    Description copied from interface: Type
    
    Checks if the type refers to a node.
    
    Specified by:
    
    isNode in interface Type
    
    Returns:
    result of check
  - isNumber
```
public final boolean isNumber()
```
    Description copied from interface: Type
    
    Checks if the type refers to a number.
    
    Specified by:
    
    isNumber in interface Type
    
    Returns:
    result of check
  - seqType
```
public final SeqType seqType()
```
    Description copied from interface: Type
    
    Returns the sequence type of this data type.
    
    Specified by:
    
    seqType in interface Type
    
    Returns:
    sequence type
  - isString
```
public final boolean isString()
```
    Description copied from interface: Type
    
    Checks if the type refers to an xs:string or one of its sub-types.
    
    Specified by:
    
    isString in interface Type
    
    Returns:
    result of check
  - isUntyped
```
public final boolean isUntyped()
```
    Description copied from interface: Type
    
    Checks if the type refers to an untyped item.
    
    Specified by:
    
    isUntyped in interface Type
    
    Returns:
    result of check
  - isFunction
```
public final boolean isFunction()
```
    Description copied from interface: Type
    
    Checks if the type refers to a function item.
    
    Specified by:
    
    isFunction in interface Type
    
    Returns:
    result of check
  - string
```
public byte[] string()
```
    Description copied from interface: Type
    
    Returns the string representation of this type.
    
    Specified by:
    
    string in interface Type
    
    Returns:
    name
  - cast
```
public FItem cast(Item it,
         QueryContext ctx,
         InputInfo ii)
           throws QueryException
```
    Description copied from interface: Type
    
    Casts the specified item to the XQuery data type.
    
    Specified by:
    
    cast in interface Type
    
    Parameters:
    it - item to be converted
    ctx - query context
    ii - input info
    
    Returns:
    new item
    
    Throws:
    
    QueryException - query exception
  - cast
```
public final Item cast(java.lang.Object o,
        InputInfo ii)
```
    Description copied from interface: Type
    
    Casts the specified Java object to the XQuery data type.
    
    Specified by:
    
    cast in interface Type
    
    Parameters:
    o - Java object
    ii - input info
    
    Returns:
    new item
  - instanceOf
```
public final boolean instanceOf(Type t)
```
    Description copied from interface: Type
    
    Checks if the current type is an instance of the specified type.
    
    Specified by:
    
    instanceOf in interface Type
    
    Parameters:
    t - type to be checked
    
    Returns:
    result of check
  - get
```
public static FuncType get(SeqType ret,
           SeqType... args)
```
    Getter for function types.
    
    Parameters:
    ret - return type
    args - argument types
    
    Returns:
    function type
  - find
```
public static Type find(QNm type)
```
    Finds and returns the specified function type.
    
    Parameters:
    type - type as string
    
    Returns:
    type or null
  - arity
```
public static FuncType arity(int a)
```
    Getter for function types with a given arity.
    
    Parameters:
    a - number of arguments
    
    Returns:
    function type
  - get
```
public static FuncType get(UserFunc f)
```
    Getter for a function's type.
    
    Parameters:
    f - user-defined function
    
    Returns:
    function type
  - type
```
public final Var[] type(Var[] vars)
```
    Sets the types of the given variables.
    
    Parameters:
    vars - variables to type
    
    Returns:
    the variables for convenience
  - isDuration
```
public boolean isDuration()
```
    Description copied from interface: Type
    
    Checks if the type refers to a xs:duration or one of its sub-types.
    
    Specified by:
    
    isDuration in interface Type
    
    Returns:
    result of check
  - isDate
```
public boolean isDate()
```
    Description copied from interface: Type
    
    Checks if the type refers to a date or one of its sub-types.
    
    Specified by:
    
    isDate in interface Type
    
    Returns:
    result of check
  - isMap
```
public boolean isMap()
```
    Description copied from interface: Type
    
    Checks if the type refers to a map.
    
    Specified by:
    
    isMap in interface Type
    
    Returns:
    result of check
  - id
```
public int id()
```
    Description copied from interface: Type
    
    Returns a type id to differentiate all types.
    
    Specified by:
    
    id in interface Type
    
    Returns:
    id
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface Type
    
    Overrides:
    
    toString in class java.lang.Object

Class FuncType

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY_FUN

args

ret

Method Detail

isNode

isNumber

seqType

isString

isUntyped

isFunction

string

cast

cast

instanceOf

get

find

arity

get

type

isDuration

isDate

isMap

id

toString