IDispatchHandler.java

/*******************************************************************************
 * Copyright 2013 Geoscience Australia
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package au.gov.ga.earthsci.intent.dispatch;

import org.eclipse.e4.core.contexts.IEclipseContext;

import au.gov.ga.earthsci.intent.Intent;

/**
 * Handles a dispatched domain object of a particular class.
 * <p/>
 * Upon instatiation, an {@link IEclipseContext} is used to inject any annotated
 * methods/fields into this object.
 * 
 * @author Michael de Hoog (michael.dehoog@ga.gov.au)
 */
public interface IDispatchHandler
{
	/**
	 * Handle the given dispatched domain object.
	 * 
	 * @param object
	 *            Dispatched object
	 * @param intent
	 *            Intent that loaded the object, can be <code>null</code> if the
	 *            object is not the result of an intent
	 */
	void handle(Object object, Intent intent);
}