Interface QueryOptions

@NonExtendable
public interface QueryOptions

Represents the parameters for a lookup query.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QueryOptions.Builder	Builder for QueryOptions.

Method Summary

Modifier and Type	Method	Description
static @NonNull QueryOptions.Builder	builder(@NonNull QueryMode mode)	Creates a new QueryOptions.Builder for the given QueryMode.
@NonNull ImmutableContextSet	context()	Gets the context, if the options are contextual.
static @NonNull QueryOptions	contextual(@NonNull ContextSet context)	Creates a contextual QueryOptions instance with the given context and default flags.
static @NonNull QueryOptions	contextual(@NonNull ContextSet context, @NonNull Set<Flag> flags)	Creates a contextual QueryOptions instance with the given context and flags.
static @NonNull QueryOptions	defaultContextualOptions()	Gets the default contextual query options.
boolean	flag(@NonNull Flag flag)	Gets if the given Flag is set.
@NonNull Set<Flag>	flags()	Gets the Flags which are set.
@NonNull QueryMode	mode()	Gets the QueryMode.
static @NonNull QueryOptions	nonContextual()	Gets the default non contextual query options.
static @NonNull QueryOptions	nonContextual(@NonNull Set<Flag> flags)	Creates a non contextual QueryOptions instance with the given flags.
<O> @NonNull Optional<O>	option(@NonNull OptionKey<O> key)	Gets the value assigned to the given OptionKey.
@NonNull Map<OptionKey<?>,Object>	options()	Gets the options which are set.
default boolean	satisfies(@NonNull ContextSet contextSet)	Gets whether this QueryOptions satisfies the given required context.
boolean	satisfies(@NonNull ContextSet contextSet, @NonNull ContextSatisfyMode defaultContextSatisfyMode)	Gets whether this QueryOptions satisfies the given required context.
@NonNull QueryOptions.Builder	toBuilder()	Converts this QueryOptions to a mutable builder.

Method Details

builder

static @NonNull QueryOptions.Builder builder(@NonNull QueryMode mode)

Creates a new QueryOptions.Builder for the given QueryMode.

Parameters:

mode - the query mode

Returns:

a new builder

contextual

static @NonNull QueryOptions contextual(@NonNull ContextSet context,
 @NonNull Set<Flag> flags)

Creates a contextual QueryOptions instance with the given context and flags.

Parameters:

context - the contexts to query in

flags - the query flags

Returns:

the query options

contextual

static @NonNull QueryOptions contextual(@NonNull ContextSet context)

Creates a contextual QueryOptions instance with the given context and default flags.

Parameters:

context - the contexts to query in

Returns:

the query options

nonContextual

static @NonNull QueryOptions nonContextual(@NonNull Set<Flag> flags)

Creates a non contextual QueryOptions instance with the given flags.

Parameters:

flags - the query flags

Returns:

the query options

nonContextual

static @NonNull QueryOptions nonContextual()

Gets the default non contextual query options.

This instance has the default set of flags.

Returns:

the default non contextual query options

defaultContextualOptions

static @NonNull QueryOptions defaultContextualOptions()

Gets the default contextual query options.

This instance has the default set of flags, and an empty set of contexts.

Returns:

the default contextual query options

mode

@NonNull QueryMode mode()

Gets the QueryMode.

Returns:

the query mode

context

@NonNull ImmutableContextSet context()

Gets the context, if the options are contextual.

Throws IllegalStateException if the mode is QueryMode.NON_CONTEXTUAL.

Returns:

the context

flag

boolean flag(@NonNull Flag flag)

Gets if the given Flag is set.

Parameters:

flag - the flag

Returns:

if the flag is set

flags

@NonNull Set<Flag> flags()

Gets the Flags which are set.

Returns:

the flags

option

<O> @NonNull Optional<O> option(@NonNull OptionKey<O> key)

Gets the value assigned to the given OptionKey.

Returns an empty optional if the option has not been set.

Type Parameters:

O - the option type

Parameters:

key - the key to lookup

Returns:

the value assigned to the key

options

@NonNull Map<OptionKey<?>,Object> options()

Gets the options which are set.

Returns:

the options

satisfies

default boolean satisfies(@NonNull ContextSet contextSet)

Gets whether this QueryOptions satisfies the given required context.

ContextSatisfyMode.AT_LEAST_ONE_VALUE_PER_KEY is used if this QueryOptions instance doesn't have the option key set.

Parameters:

contextSet - the contexts

Returns:

the result

satisfies

boolean satisfies(@NonNull ContextSet contextSet,
 @NonNull ContextSatisfyMode defaultContextSatisfyMode)

Gets whether this QueryOptions satisfies the given required context.

The defaultContextSatisfyMode parameter is used if this QueryOptions instance doesn't have the option key set.

Parameters:

contextSet - the contexts

defaultContextSatisfyMode - the default context satisfy mode to use

Returns:

the result

Since:

5.2

toBuilder

@NonNull QueryOptions.Builder toBuilder()

Converts this QueryOptions to a mutable builder.

Returns:

a builder, with the same properties already set