org.eclipse.ui.services.IDisposable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.ui.services;

/**
 * 
 * The interface that should be implemented by services that make themselves
 * available through the IAdaptable mechanism. This is the
 * interface that drives the majority of services provided at the workbench
 * level.
 * 
 * 
 * A service has life-cycle. When the constructor completes, the service must be
 * fully functional. When it comes time for the service to go away, then the
 * service will receive a {@link #dispose()} call. At this point, the service
 * must release all resources and detach all listeners. A service can only be
 * disposed once; it cannot be reused.
 * 
 * 
 * This interface has nothing to do with OSGi services.
 * 
 * 
 * This interface can be extended or implemented by clients.
 * 
 * 
 * @since 3.2
 */
public interface IDisposable {

	/**
	 * Disposes of this service. All resources must be freed. All listeners must
	 * be detached. Dispose will only be called once during the life cycle of a
	 * service.
	 */
	public void dispose();
}