ReceivesValue.java

/*
 * Copyright 2012, We The Internet Ltd.
 *
 * All rights reserved.
 *
 * Distributed under a modified BSD License as follow:
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution, unless otherwise
 * agreed to in a written document signed by a director of We The Internet Ltd.
 *
 * Neither the name of We The Internet nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package xapi.util.api;

/**
 * A basic interface to be used to receive an object of the declared type.
 *
 * @author James X Nelson (james@wetheinter.net, @ajax)
 *
 * @param <X> - The type of data this receiver requires.
 */

public interface ReceivesValue <T>{

  ReceivesValue NO_OP = new NoOp();

  /**
   * set() can be used either as an asynchronous method callback,
   * or as an actual setter for a {@link Bean} value.
   *
   * @param value - The object to receive.
   */
	public void set(T value);

	/**
	 * A handy Non-operational class that defaults to do nothing.
	 *
	 * Saves you from having to explicitly declare an empty class.
	 *
	 * @author James X. Nelson (james@wetheinter.net, @james)
	 *
	 * @param <T>
	 */
  class NoOp <T> implements ReceivesValue<T>{
	  @Override public void set(T value) {}
  }

  interface ReceivesValueUnsafe <T> {

	void set(T value) throws Throwable;
  }

}