Interface Option.Builder<T>
public static interface Option.Builder<T>
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Returns theOption.defaultValue(T value) The default value.description(net.kyori.adventure.text.Component description) The option description.global(boolean global) Whether this option should only apply globally to all claims.The plugin id.multiValued(boolean multi) Whether the option supports multiple values.The option name.requiredContextKeys(Set<String> keys) The required context keys.reset()Resets the builder to default settings.
-
Method Details
-
type
-
id
The plugin id.- Parameters:
id- The plugin id- Returns:
- The builder
-
name
The option name.- Parameters:
name- The option name- Returns:
- The builder
-
description
The option description.- Parameters:
description- The option description- Returns:
- The builder
-
defaultValue
The default value.- Parameters:
value-- Returns:
- The builder
-
multiValued
Whether the option supports multiple values.- Parameters:
multi- True if multi, false otherwise- Returns:
- The builder
-
requiredContextKeys
The required context keys.- Parameters:
keys- The context keys- Returns:
- The builder
-
global
Whether this option should only apply globally to all claims.- Parameters:
global- True if applies globally, false otherwise- Returns:
- The builder
-
reset
Option.Builder<T> reset()Resets the builder to default settings.- Returns:
- The builder
-
build
Returns theOption.- Returns:
- The option
-