MaskingFunction (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.masking.MaskingFunction

All Implemented Interfaces:

AssignmentTestable, Function, ScalarFunction

Direct Known Subclasses:

DefaultMaskingFunction, HashMaskingFunction, NullMaskingFunction, PartialMaskingFunction, ReplaceMaskingFunction
```
public abstract class MaskingFunction
extends NativeScalarFunction
```
A NativeScalarFunction that totally or partially replaces the original value of a column value, meant to obscure the real value of the column.
The names of all masking functions share a common prefix, NAME_PREFIX, to easily identify their purpose.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class MaskingFunction.Factory
- Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.AssignmentTestable
  AssignmentTestable.TestResult

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String NAME_PREFIX
The common prefix for the names of all the native data masking functions.
- 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
Modifier	Constructor	Description
`protected`	`MaskingFunction(FunctionName name, AbstractType<?> outputType, AbstractType<?> inputType, AbstractType<?>... argsType)`

Method Summary
- 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, newArguments, 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, newArguments, referencesUserType, returnType
- Methods inherited from interface org.apache.cassandra.cql3.functions.ScalarFunction
  execute, isMonotonic, partialApplication

- Field Detail
  - NAME_PREFIX
```
public static final java.lang.String NAME_PREFIX
```
    The common prefix for the names of all the native data masking functions.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MaskingFunction
```
protected MaskingFunction(FunctionName name,
                          AbstractType<?> outputType,
                          AbstractType<?> inputType,
                          AbstractType<?>... argsType)
```
    Parameters:
    
    name - the name of the function
    
    outputType - the type of the values returned by the function
    
    inputType - the type of the values accepted by the function, always be the first argument of the function
    
    argsType - the type of the additional arguments of the function