tools/remotetools/org.eclipse.ptp.remotetools.preferences/src/org/eclipse/ptp/remotetools/preferences/events/PreferencesChangeEvent.java

/**
 * Copyright (c) 2006 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - Initial Implementation
 *
 */
package org.eclipse.ptp.remotetools.preferences.events;

import java.util.EventObject;


/**
 * 
 * @author Ricardo M. Matinata
 * @since 1.0
 */
public class PreferencesChangeEvent extends EventObject {
	
	/**
	 * 
	 */
	private static final long serialVersionUID = 4835020254788026229L;

	/**
	 * The name of the changed property.
	 */
	private String propertyName;

	/**
	 * The old value of the changed property, or <code>null</code> if
	 * not known or not relevant.
	 */
	private Object oldValue;

	/**
	 * The new value of the changed property, or <code>null</code> if
	 * not known or not relevant.
	 */
	private Object newValue;

	/**
	 * Creates a new property change event.
	 *
	 * @param source the object whose property has changed
	 * @param property the property that has changed (must not be 
	 *    <code>null</code>)
	 * @param oldValue the old value of the property, or 
	 *    <code>null</code> if none
	 * @param newValue the new value of the property, or 
	 *    <code>null</code> if none
	 */
	public PreferencesChangeEvent(Object source, String property, Object oldValue, Object newValue) {
		super(source);
		if (property == null) {
			throw new IllegalArgumentException();
		}
		this.propertyName = property;
		this.oldValue = oldValue;
		this.newValue = newValue;
	}

	/**
	 * Returns the name of the property that changed.
	 * <p>
	 * Warning: there is no guarantee that the property name returned
	 * is a constant string.  Callers must compare property names using
	 * <code>equals</code>, not ==.
	 *</p>
	 * 
	 * @return the name of the property that changed
	 */
	public String getProperty() {
		return propertyName;
	}

	/**
	 * Returns the new value of the property.
	 *
	 * @return the new value, or <code>null</code> if not known
	 *  or not relevant
	 */
	public Object getNewValue() {
		return newValue;
	}

	/**
	 * Returns the old value of the property.
	 *
	 * @return the old value, or <code>null</code> if not known
	 *  or not relevant
	 */
	public Object getOldValue() {
		return oldValue;
	}

}