visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/util/Event.java

/*******************************************************************************
 * Copyright (c) 2012, 2016 Tilera Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     William R. Swanson (Tilera Corporation)
 *******************************************************************************/

package org.eclipse.cdt.visualizer.ui.util;

// ---------------------------------------------------------------------------
// Event
// ---------------------------------------------------------------------------

/**
 * Base class for events
 */
public class Event {

	// --- event types ---

	/** Event type constant */
	public static final int UNDEFINED = 0;

	// --- members ---

	/** Source of the event */
	protected Object m_source = null;

	/** Type of event */
	protected int m_type = UNDEFINED;

	// --- constructors/destructors ---

	/** Constructor */
	public Event(Object source) {
		this(source, UNDEFINED);
	}

	/** Constructor */
	public Event(Object source, int type) {
		m_source = source;
		m_type = type;
	}

	/** Dispose method */
	public void dispose() {
		m_source = null;
	}

	// --- Object methods ---

	/** Returns string representation of event */
	@Override
	public String toString() {
		StringBuilder result = new StringBuilder();
		result.append(getClass().getSimpleName());
		result.append("["); //$NON-NLS-1$
		if (m_type != UNDEFINED) {
			result.append(typeToString(m_type));
		}
		result.append("]"); //$NON-NLS-1$
		return result.toString();
	}

	/** Converts event type to string */
	public String typeToString(int type) {
		String result = ""; //$NON-NLS-1$
		switch (type) {
		case UNDEFINED:
			result = "UNDEFINED"; //$NON-NLS-1$
			break;
		default:
			result = "OTHER(" + type + ")"; //$NON-NLS-1$ //$NON-NLS-2$
			break;
		}
		return result;
	}

	// --- accessors ---

	/** Gets source of the event */
	public Object getSource() {
		return m_source;
	}

	/**
	 * Gets type of event
	 */
	public int getType() {
		return m_type;
	}

	/**
	 * Returns true if event has specified type.
	 */
	public boolean isType(int type) {
		return (m_type == type);
	}
}