Package com.apple.foundationdb.record.query.plan

Class QueryPlanInfo

java.lang.Object

com.apple.foundationdb.record.query.plan.QueryPlanInfo

public class QueryPlanInfo
extends Object

This class holds some additional information regarding the query plan that can be attached to the plan itself, without impacting its structure. This info can be added during planning to help reason about the plan and the planning process.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryPlanInfo.QueryPlanInfoKey<T>	An implementation of a type-safe Enum.

Constructor Summary

Constructors

Constructor	Description
QueryPlanInfo()

Method Summary

Modifier and Type	Method	Description
<T> boolean	containsKey(QueryPlanInfo.QueryPlanInfoKey<T> key)	Returns TRUE if the given key exists in the info table.
<T> T	get(QueryPlanInfo.QueryPlanInfoKey<T> key)	Retrieve a value from the info table.
boolean	isEmpty()	Return TRUE if the info set is empty.
Set<QueryPlanInfo.QueryPlanInfoKey<?>>	keySet()	Return the Key Set for info map.
<T> QueryPlanInfo	put(QueryPlanInfo.QueryPlanInfoKey<T> key, T value)	Set a value for the given key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryPlanInfo

public QueryPlanInfo()

Method Detail

containsKey

public <T> boolean containsKey(@Nonnull
                               QueryPlanInfo.QueryPlanInfoKey<T> key)

Returns TRUE if the given key exists in the info table.

Type Parameters:

T - The type of the value (not used in this method)

Parameters:

key - the key to look for

Returns:

TRUE if the key exists in the table, FALSE otherwise

get

@Nullable
public <T> T get(@Nonnull
                 QueryPlanInfo.QueryPlanInfoKey<T> key)

Retrieve a value from the info table.

Type Parameters:

T - the type of value returned (determined by the key generic type)

Parameters:

key - the key to look for

Returns:

the value for the key, null if not found

put

@Nonnull
public <T> QueryPlanInfo put(@Nonnull
                             QueryPlanInfo.QueryPlanInfoKey<T> key,
                             @Nonnull
                             T value)

Set a value for the given key.

Type Parameters:

T - the type of the value to set (determined by the Key generic type)

Parameters:

key - the key to use

value - the value to associate with the key

Returns:

this

isEmpty

public boolean isEmpty()

Return TRUE if the info set is empty.

Returns:

TRUE if the info set is empty

keySet

@Nonnull
public Set<QueryPlanInfo.QueryPlanInfoKey<?>> keySet()

Return the Key Set for info map.

Returns:

the Key Sey for the info map