bundles/org.eclipse.core.databinding.property/src/org/eclipse/core/databinding/property/INativePropertyListener.java

/*******************************************************************************
 * Copyright (c) 2008, 2009 Matthew Hall and others.
 * 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:
 *     Matthew Hall - initial API and implementation (bug 194734)
 *     Matthew Hall - bugs 265561, 278311
 ******************************************************************************/

package org.eclipse.core.databinding.property;

import org.eclipse.core.databinding.property.list.SimpleListProperty;
import org.eclipse.core.databinding.property.map.SimpleMapProperty;
import org.eclipse.core.databinding.property.set.SimpleSetProperty;
import org.eclipse.core.databinding.property.value.SimpleValueProperty;

/**
 * A listener capable of adding or removing itself as a listener on a source
 * object using the source's "native" listener API. Events received from the
 * source objects are parlayed to the {@link ISimplePropertyListener} provided
 * to the method that constructed this native listener instance.
 * 
 * @since 1.2
 * @see NativePropertyListener
 * @see SimpleValueProperty#adaptListener(ISimplePropertyListener)
 * @see SimpleListProperty#adaptListener(ISimplePropertyListener)
 * @see SimpleSetProperty#adaptListener(ISimplePropertyListener)
 * @see SimpleMapProperty#adaptListener(ISimplePropertyListener)
 */
public interface INativePropertyListener {
	/**
	 * Adds the receiver as a listener for property events on the specified
	 * property source.
	 * 
	 * @param source
	 *            the property source (may be null)
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public void addTo(Object source);

	/**
	 * Removes the receiver as a listener for property events on the specified
	 * property source.
	 * 
	 * @param source
	 *            the property source (may be null)
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public void removeFrom(Object source);
}