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 Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.nio.ByteBuffer`	`execute(ProtocolVersion protocolVersion, java.util.List<java.nio.ByteBuffer> parameters)`	Applies this function to the specified parameter.

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

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

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

Methods inherited from interface org.apache.cassandra.cql3.AssignmentTestable
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
  - execute
```
public java.nio.ByteBuffer execute(ProtocolVersion protocolVersion,
                                   java.util.List<java.nio.ByteBuffer> parameters)
                            throws InvalidRequestException
```
    Description copied from interface: ScalarFunction
    
    Applies this function to the specified parameter.
    
    Parameters:
    
    protocolVersion - protocol version used for parameters and return value
    
    parameters - the input parameters
    
    Returns:
    
    the result of applying this function to the parameter
    
    Throws:
    
    InvalidRequestException - if this function cannot not be applied to the parameter