/******************************************************************************
 * Copyright 2020 Paul T. Grogan
 *
 * 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 edu.mit.sipg.gui.event;

import java.util.EventListener;

/**
 * The listener interface for receiving update events.
 * The class that is interested in processing a update
 * event implements this interface, and the object created
 * with that class is registered with a component using the
 * component's <code>addUpdateListener<code> method. When
 * the update event occurs, that object's appropriate
 * method is invoked.
 *
 * @author Paul T. Grogan
 * @see UpdateEvent
 */
public interface UpdateListener extends EventListener {
	
	/**
	 * Simulation completed.
	 *
	 * @param event the event
	 */
	public void simulationCompleted(UpdateEvent event);
	
	/**
	 * Simulation initialized.
	 *
	 * @param event the event
	 */
	public void simulationInitialized(UpdateEvent event);
	
	/**
	 * Invoked when simulation update occurs.
	 *
	 * @param event the event
	 */
	public void simulationUpdated(UpdateEvent event);
}
