Package org.apache.cassandra.schema

Class UserFunctions

java.lang.Object

org.apache.cassandra.schema.UserFunctions

All Implemented Interfaces:

Iterable<UserFunction>

public final class UserFunctions
extends Object
implements Iterable<UserFunction>

An immutable container for a keyspace's UDAs and UDFs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserFunctions.Builder
static enum	UserFunctions.Filter
static final class	UserFunctions.FunctionsDiff<T extends Function>

Method Summary

Modifier and Type	Method	Description
Stream<UDAggregate>	aggregatesUsingFunction(Function function)
static UserFunctions.Builder	builder()
boolean	equals(Object o)
UserFunctions	filter(Predicate<UserFunction> predicate)
Optional<UserFunction>	find(FunctionName name, List<AbstractType<?>> argTypes)
Optional<UserFunction>	find(FunctionName name, List<AbstractType<?>> argTypes, UserFunctions.Filter filter)	Find the function with the specified name
Collection<UserFunction>	get(FunctionName name)	Get all function overloads with the specified name
Collection<UDAggregate>	getUdas(FunctionName name)	Get all UDAs overloads with the specified name
Collection<UDFunction>	getUdfs(FunctionName name)	Get all UDFs overloads with the specified name
int	hashCode()
boolean	isEmpty()
Iterator<UserFunction>	iterator()
static UserFunctions	none()
Iterable<UserFunction>	referencingUserType(ByteBuffer name)
int	size()
Stream<UserFunction>	stream()
String	toString()
static int	typeHashCode(List<AbstractType<?>> types)
static int	typeHashCode(AbstractType<?> t)
Stream<UDAggregate>	udas()
Stream<UDFunction>	udfs()
UserFunctions	with(UserFunction fun)	Create a Functions instance with the provided function added
UserFunctions	withAddedOrUpdated(UserFunction function)
UserFunctions	without(Function function)
UserFunctions	without(FunctionName name, List<AbstractType<?>> argTypes)	Creates a Functions instance with the function with the provided name and argument types removed
UserFunctions	withUpdatedUserType(UserType udt)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

builder

public static UserFunctions.Builder builder()

none

public static UserFunctions none()

iterator

public Iterator<UserFunction> iterator()

Specified by:

iterator in interface Iterable<UserFunction>

stream

public Stream<UserFunction> stream()

size

public int size()

udfs

public Stream<UDFunction> udfs()

Returns:

a stream of keyspace's UDFs

udas

public Stream<UDAggregate> udas()

Returns:

a stream of keyspace's UDAs

referencingUserType

public Iterable<UserFunction> referencingUserType(ByteBuffer name)

withUpdatedUserType

public UserFunctions withUpdatedUserType(UserType udt)

aggregatesUsingFunction

public Stream<UDAggregate> aggregatesUsingFunction(Function function)

Parameters:

function - the referree function

Returns:

a stream of aggregates that use the provided function as either a state or a final function

get

public Collection<UserFunction> get(FunctionName name)

Get all function overloads with the specified name

Parameters:

name - fully qualified function name

Returns:

an empty list if the function name is not found; a non-empty collection of Function otherwise

getUdfs

public Collection<UDFunction> getUdfs(FunctionName name)

Get all UDFs overloads with the specified name

Parameters:

name - fully qualified function name

Returns:

an empty list if the function name is not found; a non-empty collection of UDFunction otherwise

getUdas

public Collection<UDAggregate> getUdas(FunctionName name)

Get all UDAs overloads with the specified name

Parameters:

name - fully qualified function name

Returns:

an empty list if the function name is not found; a non-empty collection of UDAggregate otherwise

find

public Optional<UserFunction> find(FunctionName name,
 List<AbstractType<?>> argTypes)

find

public Optional<UserFunction> find(FunctionName name,
 List<AbstractType<?>> argTypes,
 UserFunctions.Filter filter)

Find the function with the specified name

Parameters:

name - fully qualified function name

argTypes - function argument types

Returns:

an empty Optional if the function name is not found; a non-empty optional of Function otherwise

isEmpty

public boolean isEmpty()

typeHashCode

public static int typeHashCode(AbstractType<?> t)

typeHashCode

public static int typeHashCode(List<AbstractType<?>> types)

filter

public UserFunctions filter(Predicate<UserFunction> predicate)

with

public UserFunctions with(UserFunction fun)

Create a Functions instance with the provided function added

without

public UserFunctions without(FunctionName name,
 List<AbstractType<?>> argTypes)

Creates a Functions instance with the function with the provided name and argument types removed

without

public UserFunctions without(Function function)

withAddedOrUpdated

public UserFunctions withAddedOrUpdated(UserFunction function)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object