Package net.kyori.adventure.pointer
Interface Pointered
-
- All Known Subinterfaces:
Audience
,ForwardingAudience
,ForwardingAudience.Single
public interface Pointered
Something that can retrieve values based on a givenPointer
.- Since:
- 4.8.0
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default <T> @NotNull Optional<T>
get(@NotNull Pointer<T> pointer)
Gets the value ofpointer
.default <T> T
getOrDefault(@NotNull Pointer<T> pointer, T defaultValue)
Gets the value ofpointer
.default <T> @UnknownNullability T
getOrDefaultFrom(@NotNull Pointer<T> pointer, @NotNull Supplier<? extends T> defaultValue)
Gets the value ofpointer
.default @NotNull Pointers
pointers()
Gets the pointers for this object.
-
-
-
Method Detail
-
get
@NotNull default <T> @NotNull Optional<T> get(@NotNull @NotNull Pointer<T> pointer)
Gets the value ofpointer
.- Type Parameters:
T
- the type- Parameters:
pointer
- the pointer- Returns:
- the value
- Since:
- 4.8.0
-
getOrDefault
@Contract("_, null -> _; _, !null -> !null") @Nullable default <T> T getOrDefault(@NotNull @NotNull Pointer<T> pointer, @Nullable T defaultValue)
Gets the value ofpointer
.If this
Audience
is unable to provide a value forpointer
,defaultValue
will be returned.- Type Parameters:
T
- the type- Parameters:
pointer
- the pointerdefaultValue
- the default value- Returns:
- the value
- Since:
- 4.8.0
-
getOrDefaultFrom
default <T> @UnknownNullability T getOrDefaultFrom(@NotNull @NotNull Pointer<T> pointer, @NotNull @NotNull Supplier<? extends T> defaultValue)
Gets the value ofpointer
.If this
Audience
is unable to provide a value forpointer
, the value supplied bydefaultValue
will be returned.- Type Parameters:
T
- the type- Parameters:
pointer
- the pointerdefaultValue
- the default value supplier- Returns:
- the value
- Since:
- 4.8.0
-
pointers
@NotNull default @NotNull Pointers pointers()
Gets the pointers for this object.- Returns:
- the pointers
- Since:
- 4.8.0
-
-