EventContextKey (SpongeAPI 8.2.0 API)

Type Parameters:

T - The type of the value stored with this key

All Superinterfaces:

Keyed, ResourceKeyed
```
@CatalogedBy(EventContextKeys.class)
public interface EventContextKey<T>
extends ResourceKeyed
```
A key for values in the EventContext.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface EventContextKey.Builder<T>

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.reflect.Type`	`allowedType()`	Gets the allowed type for the value of this key.
`static EventContextKey.Builder<?>`	`builder()`	Creates a builder to be used for creating a new `EventContextKey`.
`T`	`cast(java.lang.Object value)`	Cast the provided value to the value type.
`boolean`	`isInstance(java.lang.Object value)`	Return whether the value is an instance of this key's value type.

Methods inherited from interface org.spongepowered.api.ResourceKeyed
key

- Method Detail
  - builder
```
static EventContextKey.Builder<?> builder()
```
    Creates a builder to be used for creating a new EventContextKey.
    
    Returns:
    
    The constructed builder
  - allowedType
```
java.lang.reflect.Type allowedType()
```
    Gets the allowed type for the value of this key.
    This is a concrete type equal to the parameter T
    
    Returns:
    
    The allowed type
  - isInstance
```
boolean isInstance(java.lang.Object value)
```
    Return whether the value is an instance of this key's value type.
    
    Parameters:
    
    value - value to check
    
    Returns:
    
    if instance
  - cast
```
T cast(java.lang.Object value)
```
    Cast the provided value to the value type.
    
    Parameters:
    
    value - value
    
    Returns:
    
    the casted value
    
    Throws:
    
    java.lang.ClassCastException - if value is not of the correct type