org.spongepowered.api.event.cause

Class EventContext.Builder

java.lang.Object

org.spongepowered.api.event.cause.EventContext.Builder

All Implemented Interfaces:

ResettableBuilder<EventContext,EventContext.Builder>

Enclosing class:

EventContext

public static final class EventContext.Builder
extends Object
implements ResettableBuilder<EventContext,EventContext.Builder>

Method Summary

Modifier and Type	Method and Description
<T> EventContext.Builder	add(EventContextKey<T> key, T value) Adds the given context key value pair to the context.
EventContext	build() Creates a new EventContext.
EventContext.Builder	from(EventContext value) Resets this builder to the values of the given built object.
EventContext.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

add

public <T> EventContext.Builder add(EventContextKey<T> key,
                                    T value)

Adds the given context key value pair to the context.

Type Parameters:

T - The type of the value stored with the key

Parameters:

key - The key

value - The value

Returns:

This builder, for chaining

from

public EventContext.Builder from(EventContext value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface ResettableBuilder<EventContext,EventContext.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public EventContext.Builder reset()

Description copied from interface: ResettableBuilder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface ResettableBuilder<EventContext,EventContext.Builder>

Returns:

This builder, for chaining

build

public EventContext build()

Creates a new EventContext.

Returns:

The EventContext