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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2006, 2008 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;

import org.eclipse.ui.ISourceProvider;

/**
 * 
 * A service from which all of the source providers can be retrieved.
 * 
 * 
 * This service can be acquired from your service locator:
 * 
 * 	ISourceProviderService service = (ISourceProviderService) getSite().getService(ISourceProviderService.class);
 * 
 * 
 * This service is available globally.
 * 
 * 
 *
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 *
 * @since 3.4
 * @see org.eclipse.ui.services.IEvaluationService
 */
public interface ISourceProviderService {

	/**
	 * Retrieves a source provider providing the given source. This is used by
	 * clients who only need specific sources.
	 *
	 * @param sourceName
	 *            The name of the source; must not be null.
	 * @return A source provider which provides the request source, or
	 *         null if no such source exists.
	 * @see org.eclipse.ui.ISources
	 */
	public ISourceProvider getSourceProvider(final String sourceName);

	/**
	 * Retrieves all of the source providers registered with this service at the
	 * time of this call.
	 * 
	 * org.eclipse.ui.services.IEvaluationService can be used
	 * to receive notifications about source variable changes and to
	 * evaluate core expressions against source providers.
	 * 
	 *
	 * @return The source providers registered with this service. This value is
	 *         never null, but may be empty.
	 */
	public ISourceProvider[] getSourceProviders();

}