/******************************************************************************* * 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 net.sourceforge.phpdt.core; /** * Common protocol for Java elements that support source code manipulations such * as copy, move, rename, and delete. *
* This interface is not intended to be implemented by clients. *
*/ public interface ISourceManipulation { /** * Copies this element to the given container. * * @param container the container * @param sibling the sibling element before which the copy should be inserted, * ornull
if the copy should be inserted as the last child of
* the container
* @param rename the new name for the element, or null
if the copy
* retains the name of this element
* @param replace true
if any existing child in the container with
* the target name should be replaced, and false
to throw an
* exception in the event of a name collision
* @param monitor a progress monitor
* @exception JavaModelException if this element could not be copied. Reasons include:
* CoreException
occurred while updating an underlying resource
* replace
has been specified as false
* null
*/
//void copy(IJavaElement container, IJavaElement sibling, String rename, boolean replace, IProgressMonitor monitor) throws JavaModelException;
/**
* Deletes this element, forcing if specified and necessary.
*
* @param force a flag controlling whether underlying resources that are not
* in sync with the local file system will be tolerated (same as the force flag
* in IResource operations).
* @param monitor a progress monitor
* @exception JavaModelException if this element could not be deleted. Reasons include:
* CoreException
occurred while updating an underlying resource (CORE_EXCEPTION)null
if the element should be inserted as the last child of
* the container
* @param rename the new name for the element, or null
if the
* element retains its name
* @param replace true
if any existing child in the container with
* the target name should be replaced, and false
to throw an
* exception in the event of a name collision
* @param monitor a progress monitor
* @exception JavaModelException if this element could not be moved. Reasons include:
* CoreException
occurred while updating an underlying resource
* replace
has been specified as false
* null
*/
//void move(IJavaElement container, IJavaElement sibling, String rename, boolean replace, IProgressMonitor monitor) throws JavaModelException;
/**
* Renames this element to the given name.
*
* @param name the new name for the element
* @param replace true
if any existing element with the target name
* should be replaced, and false
to throw an exception in the
* event of a name collision
* @param monitor a progress monitor
* @exception JavaModelException if this element could not be renamed. Reasons include:
* CoreException
occurred while updating an underlying resource
* replace
has been specified as false
*