Package net.luckperms.api.query

Interface QueryOptions.Builder

Enclosing interface:

QueryOptions

@NonExtendable
public static interface QueryOptions.Builder

Builder for QueryOptions.

Method Summary

Modifier and Type	Method	Description
@NonNull QueryOptions	build()	Builds a QueryOptions instance from the properties defined to the builder.
@NonNull QueryOptions.Builder	context(@NonNull ContextSet context)	Sets the context.
@NonNull QueryOptions.Builder	flag(@NonNull Flag flag, boolean value)	Sets the value of the given flag.
@NonNull QueryOptions.Builder	flags(@NonNull Set<Flag> flags)	Sets the flags.
@NonNull QueryOptions.Builder	mode(@NonNull QueryMode mode)	Sets the QueryMode.
<O> @NonNull QueryOptions.Builder	option(@NonNull OptionKey<O> key, @Nullable O value)	Sets the value of the given option.

Method Detail

mode

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

Sets the QueryMode.

Parameters:

mode - the mode to set

Returns:

this builder

context

@NonNull QueryOptions.Builder context(@NonNull ContextSet context)

Sets the context.

Note that this is a set operation, not append. Existing contexts will be overridden.

Throws IllegalStateException if the mode is not QueryMode.CONTEXTUAL.

Parameters:

context - the context to set

Returns:

this builder

flag

@NonNull QueryOptions.Builder flag(@NonNull Flag flag,
                                   boolean value)

Sets the value of the given flag.

By default, all Flags are set to true.

Parameters:

flag - the flag

value - the value to set

Returns:

this builder

flags

@NonNull QueryOptions.Builder flags(@NonNull Set<Flag> flags)

Sets the flags.

Note that this is a set operation, not append. Existing flags will be overridden.

By default, all Flags are set to true.

Parameters:

flags - the flags

Returns:

this builder

option

<O> @NonNull QueryOptions.Builder option(@NonNull OptionKey<O> key,
                                         @Nullable O value)

Sets the value of the given option.

Passing null in place of a value will clear any existing value set for the key.

Type Parameters:

O - the option type

Parameters:

key - the option key

value - the value, or null to clear

Returns:

this builder

build

@NonNull QueryOptions build()

Builds a QueryOptions instance from the properties defined to the builder.

Returns:

a QueryOptions instance.