Package org.spongepowered.api.event
Class EventContext
java.lang.Object
org.spongepowered.api.event.EventContext
Provides context for an event outside of the direct chain of causes present
in the event's
Cause
.-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionMap
<EventContextKey<?>, Object> asMap()
Gets this event context as aMap
of EventContextKeys to Objects.static EventContext.Builder
builder()
Creates a new builder for creating anEventContext
.boolean
containsKey
(Supplier<? extends EventContextKey<?>> key) Gets whether the providedEventContextKey
is included in this context.boolean
containsKey
(EventContextKey<?> key) Gets whether the providedEventContextKey
is included in this context.static EventContext
empty()
Gets an empty context.boolean
<T> Optional
<T> get
(Supplier<EventContextKey<T>> key) Gets the value corresponding to the given key from the context.<T> Optional
<T> get
(EventContextKey<T> key) Gets the value corresponding to the given key from the context.int
hashCode()
Set
<EventContextKey<?>> keySet()
Gets allEventContextKey
s present in this context.static EventContext
of
(Map<EventContextKey<?>, Object> entries) Creates a newEventContext
from the given map of entries.<T> T
require
(Supplier<EventContextKey<T>> key) Gets the value corresponding to the given key from the context.<T> T
require
(EventContextKey<T> key) Gets the value corresponding to the given key from the context.toString()
-
Method Details
-
empty
Gets an empty context.- Returns:
- The empty context
-
of
Creates a newEventContext
from the given map of entries.- Parameters:
entries
- The context entries- Returns:
- The new EventContext
-
builder
Creates a new builder for creating anEventContext
.- Returns:
- The new builder
-
get
Gets the value corresponding to the given key from the context.- Type Parameters:
T
- The type of the value stored with the key- Parameters:
key
- The key- Returns:
- The context value, if found
-
get
Gets the value corresponding to the given key from the context.- Type Parameters:
T
- The type of the value stored with the key- Parameters:
key
- The key- Returns:
- The context value, if found
-
require
Gets the value corresponding to the given key from the context.If the key is not available,
NoSuchElementException
will be thrown.- Type Parameters:
T
- The type of the value stored with the key- Parameters:
key
- The key- Returns:
- The context value, if found
-
require
Gets the value corresponding to the given key from the context.If the key is not available,
NoSuchElementException
will be thrown.- Type Parameters:
T
- The type of the value stored with the key- Parameters:
key
- The key- Returns:
- The context value, if found
-
containsKey
Gets whether the providedEventContextKey
is included in this context.- Parameters:
key
- The context key to check- Returns:
- True if the key is used and there is an entry for it
-
containsKey
Gets whether the providedEventContextKey
is included in this context.- Parameters:
key
- The context key to check- Returns:
- True if the key is used and there is an entry for it
-
keySet
Gets allEventContextKey
s present in this context.- Returns:
- All present keys
-
asMap
Gets this event context as aMap
of EventContextKeys to Objects.- Returns:
- A map view of this context
-
equals
-
hashCode
public int hashCode() -
toString
-