com.kauridev.lunarbase.Event Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lunar-base Show documentation

Lunar Base is a simple game framework written in Java. It is written using an entity-component-system architecture.

The newest version!

/*
 * This file is part of the lunar-base package.
 *
 * Copyright (c) 2014 Eric Fritz
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.kauridev.lunarbase;

/**
 * A base event interface. Events declare what object type can handle them through the generic
 * parameter. This allows a single object to listen to multiple events without handling method
 * naming conflicts.
 * 
 * The common way for an event to notify its listeners is to pass itself as a parameter to a method
 * defined in the listener interface. If the event holds any extra data, the listener can access it
 * while handling the event.
 *
 * 
 * {@code
 * public class FooEvent extends Event
 * {
 *  // Additionally, define data accessible to the listener
 *
 * 	public FooEvent notify(FooEventListener listener)
 * 	{
 * 		return listener.onFoo(this);
 * 	}
 * }
 *
 * public interface FooEventListener
 * {
 * 	public FooEvent onFoo(FooEvent event);
 * }
 * }
 * 
 *
 * @param  The type of listener which may handle this event.
 *
 * @author Eric Fritz
 */
public interface Event
{
	/**
	 * Notify the listener of this event.
	 *
	 * @param listener The listener to notify.
	 *
	 * @return The event that should be dispatched to the remaining listeners.
	 */
	public Event notify(L listener);
}