diff options
Diffstat (limited to 'bundles/org.eclipse.team.core/src/org/eclipse/team/core/IDeploymentProviderManager.java')
| -rw-r--r-- | bundles/org.eclipse.team.core/src/org/eclipse/team/core/IDeploymentProviderManager.java | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IDeploymentProviderManager.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IDeploymentProviderManager.java new file mode 100644 index 000000000..6591e1c46 --- /dev/null +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IDeploymentProviderManager.java @@ -0,0 +1,94 @@ +/******************************************************************************* + * Copyright (c) 2000, 2003 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Common Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/cpl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +package org.eclipse.team.core; + +import org.eclipse.core.resources.IContainer; +import org.eclipse.core.resources.IResource; + +/** + * Manages deployment providers. Clients can programatically map and unmap deployment + * providers to containers. + * <p> + * Clients are not intended to implement this interface. + * </p> + * @see RepositoryProvider + * @see DeploymentProvider + * @since 3.0 + */ +public interface IDeploymentProviderManager { + /** + * Maps a container to the the given provider. Mappings are persisted across + * workbench sessions. + * + * @param container the container to be mapped to the given provider + * @param provider the provider to be mapped to the container + * @throws TeamException + */ + public void map(IContainer container, DeploymentProvider provider) throws TeamException; + + /** + * Unmaps the given provider from the container. + * + * @param container the container to be unmapped from the given provider + * @param provider the provider to unmap from the container + * @throws TeamException + */ + public void unmap(IContainer container, DeploymentProvider provider) throws TeamException; + + /** + * Returns the providers associated with the given resource. This loads the providers + * if not already loaded, and can be long running. To check the existance of + * a particular mapping call {@link #getMappedTo(IResource, String)} instead. + * This method returns an empty array if there are no mappings. + * + * @param resource the resource whose mappings are to be retreived + * @return the mappings for the resource + */ + public DeploymentProvider[] getMappings(IResource resource); + + /** + * Returns the providers with the given id associated with the given resource. + * This loads the providers if not already loaded, and can be long running. + * To check the existance of a particular mapping call + * {@link #getMappedTo(IResource, String)} instead. + * This method returns an empty array if there are no mappings. This method will + * only return either an empty array or an array of length 1 if the provider + * of the given type does not support multiple mappings + * (@see DeploymentProvider#isMultipleMappingsSupported()). + * @param resource the resource whose mappings are to be retreived + * @param id the id of the provider + * @return the mappings for the resource + */ + public DeploymentProvider[] getMappings(IResource resource, String id); + + /** + * Returns <code>true</code> if the resource is mapped to the provider with + * the given id, and <code>false</code> otherwise. This method is fast running + * and won't load the provider. + * + * @param resource the resource for which to check the mapping + * @param id the id of the provider + * @return <code>true</code> if the resource is mapped to the provider with + * the given id, and <code>false</code> otherwise. + */ + public boolean getMappedTo(IResource resource, String id); + + /** + * Return an array of all the resource roots that are mapped + * to a deployment providers with the given + * id. If id is <code>null</code>, the roots of all deployment providers + * are returned. + * @param id a deployment provider id or <code>null</code> + * @return all roots that are mapped to deployment providers with + * the given id + */ + public IResource[] getDeploymentProviderRoots(String id); +}
\ No newline at end of file |