com.github.brunothg.game.engine.utils.event

Class Event<T>

java.lang.Object

com.github.brunothg.game.engine.utils.event.Event<T>

Direct Known Subclasses:

DeadEvent

public abstract class Event<T>
extends Object

Base class for each Event

Author:

Marvin Bruns

Constructor Summary

Constructors

Constructor and Description
Event()
Event(Object source)
Event(Object source, T message)

Method Summary

Modifier and Type	Method and Description
void	consume() Call this method, if you handled this event and another handler is not required.
void	consume(Object consumer) Call this method, if you handled this event and another handler is not required.
List<Object>	getConsumer()
T	getMessage()
String	getMessageString() Get the message string.
Object	getSource()
boolean	isConsumed() Test, if this event got handled before.
protected void	setConsumed(boolean consumed)
void	setMessage(T message)
void	setSource(Object source)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Event

public Event(Object source)

Event

public Event(Object source,
             T message)

Method Detail

getSource

public Object getSource()

setSource

public void setSource(Object source)

getMessage

public T getMessage()

setMessage

public void setMessage(T message)

getMessageString

public String getMessageString()

Get the message string. If it isn't a string, the toString() method will be used.

Returns:

The message or null, if not set

isConsumed

public boolean isConsumed()

Test, if this event got handled before. You may ignore this event in this case.

Returns:

true, if it was handled before

setConsumed

protected void setConsumed(boolean consumed)

consume

public void consume()

Call this method, if you handled this event and another handler is not required.

consume

public void consume(Object consumer)

Call this method, if you handled this event and another handler is not required.

Parameters:

consumer - Set the consuming object, so that other handler can react on this

See Also:

consume()

getConsumer

public List<Object> getConsumer()

toString

public String toString()

Overrides:

toString in class Object