http://www.eclipse.org/platform: Debug Core (Eclipse Foundation) 
Copyright (c) 2000, 2006 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation

/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.debug.core.sourcelookup;

import org.eclipse.core.runtime.CoreException;


A source container type delegate represents a kind of container of source code.
For example, a source container type may be a project or a directory. A specific
project or directory is represented by an instance of a source container type,
which is called a source container (ISourceContainer).


A source container type delegate is contributed via the
sourceContainerTypes extension point.




Clients may implement this interface.



See Also:
Since:3.0
/**
 * A source container type delegate represents a kind of container of source code.
 * For example, a source container type may be a project or a directory. A specific
 * project or directory is represented by an instance of a source container type,
 * which is called a source container (<code>ISourceContainer</code>).
 * <p>
 * A source container type delegate is contributed via the
 * <code>sourceContainerTypes</code> extension point.
 * </p>
 * <p>
 * Clients may implement this interface.
 * </p>
 * @see org.eclipse.debug.core.sourcelookup.ISourceContainer
 * @see org.eclipse.debug.core.sourcelookup.ISourceContainerType
 * @since 3.0
 */
public interface ISourceContainerTypeDelegate {

	
Creates and returns a new source container of this type
corresponding to the given memento.

Params:
  • memento – a memento for a source container of this source container type
Throws:
  • CoreException – if unable to construct a source container based
 on the given memento
Returns:a source container corresponding to the given memento
/**
	 * Creates and returns a new source container of this type
	 * corresponding to the given memento.
	 *
	 * @param memento a memento for a source container of this source container type
	 * @return a source container corresponding to the given memento
	 * @exception CoreException if unable to construct a source container based
	 *  on the given memento
	 */
	ISourceContainer createSourceContainer(String memento) throws CoreException;

	
Constructs and returns a memento for the given source container. A memento
can be used to reconstruct a source container.

Params:
  • container – The container for which a memento should be created. The
 container must of this source container type.
Throws:
Returns:a memento for the source container
/**
	 * Constructs and returns a memento for the given source container. A memento
	 * can be used to reconstruct a source container.
	 *
	 * @param container The container for which a memento should be created. The
	 *  container must of this source container type.
	 * @return a memento for the source container
	 * @exception CoreException if unable to create a memento
	 */
	String getMemento(ISourceContainer container) throws CoreException;

}