TokenFct (apache-cassandra API)

java.lang.Object
- org.apache.cassandra.cql3.functions.AbstractFunction
- - org.apache.cassandra.cql3.functions.NativeFunction
  - - org.apache.cassandra.cql3.functions.NativeScalarFunction
    - - org.apache.cassandra.cql3.functions.TokenFct

All Implemented Interfaces:

AssignmentTestable, Function, ScalarFunction
```
public class TokenFct
extends NativeScalarFunction
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.AssignmentTestable
  AssignmentTestable.TestResult

Field Summary
- Fields inherited from class org.apache.cassandra.cql3.functions.AbstractFunction
  argTypes, name, returnType
- Fields inherited from interface org.apache.cassandra.cql3.functions.Function
  UNRESOLVED

Constructor Summary

Constructors
Constructor Description

TokenFct(TableMetadata metadata)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`addFunctionsTo(NativeFunctions functions)`
`java.nio.ByteBuffer`	`execute(Arguments arguments)`	Applies this function to the specified arguments.
`Arguments`	`newArguments(ProtocolVersion version)`	Creates some new input arguments for this function.

Methods inherited from class org.apache.cassandra.cql3.functions.NativeScalarFunction
isAggregate, isCalledOnNullInput, isPartialApplicationMonotonic

Methods inherited from class org.apache.cassandra.cql3.functions.NativeFunction
isNative, isPure, withLegacyName

Methods inherited from class org.apache.cassandra.cql3.functions.AbstractFunction
addFunctionsTo, argTypes, argumentsList, columnName, elementKeyspace, elementName, equals, getCompatibleTypeIfKnown, hashCode, name, referencesUserType, returnType, testAssignment, toCqlString, toString, typesMatch

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

Methods inherited from interface org.apache.cassandra.cql3.AssignmentTestable
getCompatibleTypeIfKnown, testAssignment

Methods inherited from interface org.apache.cassandra.cql3.functions.Function
addFunctionsTo, argTypes, columnName, compare, isNative, isPure, name, referencesUserType, returnType

Methods inherited from interface org.apache.cassandra.cql3.functions.ScalarFunction
isMonotonic, partialApplication

- Constructor Detail
  - TokenFct
```
public TokenFct(TableMetadata metadata)
```
- Method Detail
  - newArguments
```
public Arguments newArguments(ProtocolVersion version)
```
    Description copied from interface: Function
    
    Creates some new input arguments for this function.
    
    Specified by:
    
    newArguments in interface Function
    
    Overrides:
    
    newArguments in class NativeFunction
    
    Parameters:
    
    version - the protocol version
    
    Returns:
    
    some new input arguments for this function
  - execute
```
public java.nio.ByteBuffer execute(Arguments arguments)
                            throws InvalidRequestException
```
    Description copied from interface: ScalarFunction
    
    Applies this function to the specified arguments.
    
    Parameters:
    
    arguments - the input arguments for the function
    
    Returns:
    
    the result of applying this function to the arguments
    
    Throws:
    
    InvalidRequestException - if this function cannot not be applied to the arguments
  - addFunctionsTo
```
public static void addFunctionsTo(NativeFunctions functions)
```