org.eclipse.platform/org.eclipse.core.resources/3.13.600 : org/eclipse/core/resources/IFolder.java

IFolder

http://www.eclipse.org/platform: Core Resource Management (Eclipse Foundation)

Eclipse Public License - v 2.0

 Copyright (c) 2000, 2010 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
    Serge Beauchamp (Freescale Semiconductor) - [229633] Group Support
/*******************************************************************************
 *  Copyright (c) 2000, 2010 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
 *     Serge Beauchamp (Freescale Semiconductor) - [229633] Group Support
 *******************************************************************************/
package org.eclipse.core.resources;

import java.net.URI;
import org.eclipse.core.runtime.*;

Folders may be leaf or non-leaf resources and may contain files and/or other folders.
A folder resource is stored as a directory in the local file system.

Folders, like other resource types, may exist in the workspace but
not be local; non-local folder resources serve as place-holders for
folders whose properties have not yet been fetched from a repository.


Folders implement the IAdaptable interface;
extensions are managed by the platform's adapter manager.

See Also: getAdapterManager.getAdapterManager()
@noimplement This interface is not intended to be implemented by clients.
@noextend This interface is not intended to be extended by clients./**
 * Folders may be leaf or non-leaf resources and may contain files and/or other folders.
 * A folder resource is stored as a directory in the local file system.
 * <p>
 * Folders, like other resource types, may exist in the workspace but
 * not be local; non-local folder resources serve as place-holders for
 * folders whose properties have not yet been fetched from a repository.
 * </p>
 * <p>
 * Folders implement the <code>IAdaptable</code> interface;
 * extensions are managed by the platform's adapter manager.
 * </p>
 *
 * @see Platform#getAdapterManager()
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface IFolder extends IContainer, IAdaptable {

	Creates a new folder resource as a member of this handle's parent resource.

This is a convenience method, fully equivalent to:

  create((force ? FORCE : IResource.NONE), local, monitor);


This method changes resources; these changes will be reported
in a subsequent resource change event, including an indication
that the folder has been added to its parent.


This method is long-running; progress and cancellation are provided
by the given progress monitor.

Params: force – a flag controlling how to deal with resources that
   are not in sync with the local file system
local – a flag controlling whether or not the folder will be local
   after the creation
monitor – a progress monitor, or null if progress
   reporting is not desired
Throws: CoreException – if this method fails. Reasons include:

 This resource already exists in the workspace.
 The workspace contains a resource of a different type
     at the same path as this resource.
 The parent of this resource does not exist.
 The parent of this resource is a project that is not open.
 The parent contains a resource of a different type
     at the same path as this resource.
 The parent of this resource is virtual, but this resource is not.
 The name of this resource is not valid (according to
   IWorkspace.validateName).
 The corresponding location in the local file system is occupied
   by a file (as opposed to a directory).
 The corresponding location in the local file system is occupied
   by a folder and force  is false.
 Resource changes are disallowed during certain types of resource change
      event notification.  See IResourceChangeEvent for more details.
OperationCanceledException – if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.
See Also: create(int, boolean, IProgressMonitor)/**
	 * Creates a new folder resource as a member of this handle's parent resource.
	 * <p>
	 * This is a convenience method, fully equivalent to:
	 * </p>
	 * <pre>
	 *   create((force ? FORCE : IResource.NONE), local, monitor);
	 * </pre>
	 * <p>
	 * This method changes resources; these changes will be reported
	 * in a subsequent resource change event, including an indication
	 * that the folder has been added to its parent.
	 * </p>
	 * <p>
	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor.
	 * </p>
	 *
	 * @param force a flag controlling how to deal with resources that
	 *    are not in sync with the local file system
	 * @param local a flag controlling whether or not the folder will be local
	 *    after the creation
	 * @param monitor a progress monitor, or <code>null</code> if progress
	 *    reporting is not desired
	 * @exception CoreException if this method fails. Reasons include:
	 * <ul>
	 * <li> This resource already exists in the workspace.</li>
	 * <li> The workspace contains a resource of a different type
	 *      at the same path as this resource.</li>
	 * <li> The parent of this resource does not exist.</li>
	 * <li> The parent of this resource is a project that is not open.</li>
	 * <li> The parent contains a resource of a different type
	 *      at the same path as this resource.</li>
	 * <li> The parent of this resource is virtual, but this resource is not.</li>
	 * <li> The name of this resource is not valid (according to
	 *    <code>IWorkspace.validateName</code>).</li>
	 * <li> The corresponding location in the local file system is occupied
	 *    by a file (as opposed to a directory).</li>
	 * <li> The corresponding location in the local file system is occupied
	 *    by a folder and <code>force </code> is <code>false</code>.</li>
	 * <li> Resource changes are disallowed during certain types of resource change
	 *       event notification.  See <code>IResourceChangeEvent</code> for more details.</li>
	 * </ul>
	 * @exception OperationCanceledException if the operation is canceled.
	 * Cancelation can occur even if no progress monitor is provided.
	 * @see IFolder#create(int,boolean,IProgressMonitor)
	 */
	void create(boolean force, boolean local, IProgressMonitor monitor) throws CoreException;

	Creates a new folder resource as a member of this handle's parent resource.

The FORCE update flag controls how this method deals with
cases where the workspace is not completely in sync with the local file
system. If FORCE is not specified, the method will only attempt
to create a directory in the local file system if there isn't one already.
This option ensures there is no unintended data loss; it is the recommended
setting. However, if FORCE is specified, this method will
be deemed a success even if there already is a corresponding directory.

 The IResource.DERIVED update flag indicates that this resource should immediately be set as a derived resource. Specifying this flag is equivalent to atomically calling IResource.setDerived(boolean) with a value of true immediately after creating the resource.

 The IResource.TEAM_PRIVATE update flag indicates that this resource should immediately be set as a team private resource. Specifying this flag is equivalent to atomically calling IResource.setTeamPrivateMember(boolean) with a value of true immediately after creating the resource.

 The IResource.HIDDEN update flag indicates that this resource should immediately be set as a hidden resource. Specifying this flag is equivalent to atomically calling IResource.setHidden(boolean) with a value of true immediately after creating the resource.


Update flags other than those listed above are ignored.


This method synchronizes this resource with the local file system.


This method changes resources; these changes will be reported
in a subsequent resource change event, including an indication
that the folder has been added to its parent.


This method is long-running; progress and cancellation are provided
by the given progress monitor.

Params: updateFlags – bit-wise or of update flag constants (IResource.FORCE, IResource.DERIVED, IResource.TEAM_PRIVATE) and IResource.VIRTUAL)
local – a flag controlling whether or not the folder will be local
   after the creation
monitor – a progress monitor, or null if progress
   reporting is not desired
Throws: CoreException – if this method fails. Reasons include:

 This resource already exists in the workspace.
 The workspace contains a resource of a different type
     at the same path as this resource.
 The parent of this resource does not exist.
 The parent of this resource is a project that is not open.
 The parent contains a resource of a different type
     at the same path as this resource.
 The parent of this resource is virtual, but this resource is not.
 The name of this resource is not valid (according to
   IWorkspace.validateName).
 The corresponding location in the local file system is occupied
   by a file (as opposed to a directory).
 The corresponding location in the local file system is occupied
   by a folder and FORCE is not specified.
 Resource changes are disallowed during certain types of resource change
      event notification.  See IResourceChangeEvent for more details.
OperationCanceledException – if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.
See Also: IResourceRuleFactory.createRule(IResource)
Since: 2.0/**
	 * Creates a new folder resource as a member of this handle's parent resource.
	 * <p>
	 * The <code>FORCE</code> update flag controls how this method deals with
	 * cases where the workspace is not completely in sync with the local file
	 * system. If <code>FORCE</code> is not specified, the method will only attempt
	 * to create a directory in the local file system if there isn't one already.
	 * This option ensures there is no unintended data loss; it is the recommended
	 * setting. However, if <code>FORCE</code> is specified, this method will
	 * be deemed a success even if there already is a corresponding directory.
	 * </p>
	 * <p>
	 * The {@link IResource#DERIVED} update flag indicates that this resource
	 * should immediately be set as a derived resource.  Specifying this flag
	 * is equivalent to atomically calling {@link IResource#setDerived(boolean)}
	 * with a value of <code>true</code> immediately after creating the resource.
	 * </p>
	 * <p>
	 * The {@link IResource#TEAM_PRIVATE} update flag indicates that this resource
	 * should immediately be set as a team private resource.  Specifying this flag
	 * is equivalent to atomically calling {@link IResource#setTeamPrivateMember(boolean)}
	 * with a value of <code>true</code> immediately after creating the resource.
	 * </p>
	 * <p>
	 * The {@link IResource#HIDDEN} update flag indicates that this resource
	 * should immediately be set as a hidden resource.  Specifying this flag
	 * is equivalent to atomically calling {@link IResource#setHidden(boolean)}
	 * with a value of <code>true</code> immediately after creating the resource.
	 * </p>
	 * <p>
	 * Update flags other than those listed above are ignored.
	 * </p>
	 * <p>
	 * This method synchronizes this resource with the local file system.
	 * </p>
	 * <p>
	 * This method changes resources; these changes will be reported
	 * in a subsequent resource change event, including an indication
	 * that the folder has been added to its parent.
	 * </p>
	 * <p>
	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor.
	 * </p>
	 *
	 * @param updateFlags bit-wise or of update flag constants
	 *   ({@link IResource#FORCE}, {@link IResource#DERIVED}, {@link IResource#TEAM_PRIVATE})
	 *   and {@link IResource#VIRTUAL})
	 * @param local a flag controlling whether or not the folder will be local
	 *    after the creation
	 * @param monitor a progress monitor, or <code>null</code> if progress
	 *    reporting is not desired
	 * @exception CoreException if this method fails. Reasons include:
	 * <ul>
	 * <li> This resource already exists in the workspace.</li>
	 * <li> The workspace contains a resource of a different type
	 *      at the same path as this resource.</li>
	 * <li> The parent of this resource does not exist.</li>
	 * <li> The parent of this resource is a project that is not open.</li>
	 * <li> The parent contains a resource of a different type
	 *      at the same path as this resource.</li>
	 * <li> The parent of this resource is virtual, but this resource is not.</li>
	 * <li> The name of this resource is not valid (according to
	 *    <code>IWorkspace.validateName</code>).</li>
	 * <li> The corresponding location in the local file system is occupied
	 *    by a file (as opposed to a directory).</li>
	 * <li> The corresponding location in the local file system is occupied
	 *    by a folder and <code>FORCE</code> is not specified.</li>
	 * <li> Resource changes are disallowed during certain types of resource change
	 *       event notification.  See <code>IResourceChangeEvent</code> for more details.</li>
	 * </ul>
	 * @exception OperationCanceledException if the operation is canceled.
	 * Cancelation can occur even if no progress monitor is provided.
	 * @see IResourceRuleFactory#createRule(IResource)
	 * @since 2.0
	 */
	void create(int updateFlags, boolean local, IProgressMonitor monitor) throws CoreException;

	Creates a new folder resource as a member of this handle's parent resource.
The folder's contents will be located in the directory specified by the given
file system path.  The given path must be either an absolute file system
path, or a relative path whose first segment is the name of a workspace path
variable.

The ALLOW_MISSING_LOCAL update flag controls how this
method deals with cases where the local file system directory to be linked does
not exist, or is relative to a workspace path variable that is not defined.
If ALLOW_MISSING_LOCAL is specified, the operation will succeed
even if the local directory is missing, or the path is relative to an
undefined variable. If ALLOW_MISSING_LOCAL is not specified, the
operation will fail in the case where the local file system directory does
not exist or the path is relative to an undefined variable.

 The IResource.REPLACE update flag controls how this method deals with cases where a resource of the same name as the prospective link already exists. If IResource.REPLACE is specified, then the existing linked resource's location is replaced by localLocation's value. This does not cause the underlying file system contents of that resource to be deleted. If IResource.REPLACE is not specified, this method will fail if an existing resource exists of the same name. 
 The IResource.BACKGROUND_REFRESH update flag controls how this method synchronizes the new resource with the filesystem. If this flag is specified, resources on disk will be synchronized in the background after the method returns. Child resources of the link may not be available until this background refresh completes. If this flag is not specified, resources are synchronized in the foreground before this method returns. 
 The IResource.HIDDEN update flag indicates that this resource should immediately be set as a hidden resource. Specifying this flag is equivalent to atomically calling IResource.setHidden(boolean) with a value of true immediately after creating the resource.


Update flags other than those listed above are ignored.


This method changes resources; these changes will be reported
in a subsequent resource change event, including an indication
that the folder has been added to its parent.


This method is long-running; progress and cancellation are provided
by the given progress monitor.

Params: localLocation – a file system path where the folder should be linked
updateFlags – bit-wise or of update flag constants (IResource.ALLOW_MISSING_LOCAL, IResource.REPLACE, IResource.BACKGROUND_REFRESH, and IResource.HIDDEN)
monitor – a progress monitor, or null if progress
   reporting is not desired
Throws: CoreException – if this method fails. Reasons include:

 This resource already exists in the workspace.
 The workspace contains a resource of a different type
     at the same path as this resource.
 The parent of this resource does not exist.
 The parent of this resource is not an open project
 The name of this resource is not valid (according to
   IWorkspace.validateName).
 The corresponding location in the local file system does not exist, or
is relative to an undefined variable, and ALLOW_MISSING_LOCAL is
not specified.
 The corresponding location in the local file system is occupied
   by a file (as opposed to a directory).
 Resource changes are disallowed during certain types of resource change
      event notification.  See IResourceChangeEvent for more details.
The team provider for the project which contains this folder does not permit
      linked resources.
This folder's project contains a nature which does not permit linked resources.
OperationCanceledException – if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.
See Also: IResource.isLinked()
IResource.ALLOW_MISSING_LOCAL
IResource.REPLACE
IResource.BACKGROUND_REFRESH
IResource.HIDDEN
Since: 2.1/**
	 * Creates a new folder resource as a member of this handle's parent resource.
	 * The folder's contents will be located in the directory specified by the given
	 * file system path.  The given path must be either an absolute file system
	 * path, or a relative path whose first segment is the name of a workspace path
	 * variable.
	 * <p>
	 * The <code>ALLOW_MISSING_LOCAL</code> update flag controls how this
	 * method deals with cases where the local file system directory to be linked does
	 * not exist, or is relative to a workspace path variable that is not defined.
	 * If <code>ALLOW_MISSING_LOCAL</code> is specified, the operation will succeed
	 * even if the local directory is missing, or the path is relative to an
	 * undefined variable. If <code>ALLOW_MISSING_LOCAL</code> is not specified, the
	 * operation will fail in the case where the local file system directory does
	 * not exist or the path is relative to an undefined variable.
	 * </p>
	 * <p>
	 * The {@link IResource#REPLACE} update flag controls how this
	 * method deals with cases where a resource of the same name as the
	 * prospective link already exists. If {@link IResource#REPLACE}
	 * is specified, then the existing linked resource's location is replaced
	 * by localLocation's value.  This does <b>not</b>
	 * cause the underlying file system contents of that resource to be deleted.
	 * If {@link IResource#REPLACE} is not specified, this method will
	 * fail if an existing resource exists of the same name.
	 * </p>
	 * <p>
	 * The {@link IResource#BACKGROUND_REFRESH} update flag controls how
	 * this method synchronizes the new resource with the filesystem. If this flag is
	 * specified, resources on disk will be synchronized in the background after the
	 * method returns. Child resources of the link may not be available until
	 * this background refresh completes. If this flag is not specified, resources are
	 * synchronized in the foreground before this method returns.
	 * </p>
	 * <p>
	 * The {@link IResource#HIDDEN} update flag indicates that this resource
	 * should immediately be set as a hidden resource.  Specifying this flag
	 * is equivalent to atomically calling {@link IResource#setHidden(boolean)}
	 * with a value of <code>true</code> immediately after creating the resource.
	 * </p>
	 * <p>
	 * Update flags other than those listed above are ignored.
	 * </p>
	 * <p>
	 * This method changes resources; these changes will be reported
	 * in a subsequent resource change event, including an indication
	 * that the folder has been added to its parent.
	 * </p>
	 * <p>
	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor.
	 * </p>
	 *
	 * @param localLocation a file system path where the folder should be linked
	 * @param updateFlags bit-wise or of update flag constants
	 *   ({@link IResource#ALLOW_MISSING_LOCAL}, {@link IResource#REPLACE}, {@link IResource#BACKGROUND_REFRESH}, and {@link IResource#HIDDEN})
	 * @param monitor a progress monitor, or <code>null</code> if progress
	 *    reporting is not desired
	 * @exception CoreException if this method fails. Reasons include:
	 * <ul>
	 * <li> This resource already exists in the workspace.</li>
	 * <li> The workspace contains a resource of a different type
	 *      at the same path as this resource.</li>
	 * <li> The parent of this resource does not exist.</li>
	 * <li> The parent of this resource is not an open project</li>
	 * <li> The name of this resource is not valid (according to
	 *    <code>IWorkspace.validateName</code>).</li>
	 * <li> The corresponding location in the local file system does not exist, or
	 * is relative to an undefined variable, and <code>ALLOW_MISSING_LOCAL</code> is
	 * not specified.</li>
	 * <li> The corresponding location in the local file system is occupied
	 *    by a file (as opposed to a directory).</li>
	 * <li> Resource changes are disallowed during certain types of resource change
	 *       event notification.  See <code>IResourceChangeEvent</code> for more details.</li>
	 * <li>The team provider for the project which contains this folder does not permit
	 *       linked resources.</li>
	 * <li>This folder's project contains a nature which does not permit linked resources.</li>
	 * </ul>
	 * @exception OperationCanceledException if the operation is canceled.
	 * Cancelation can occur even if no progress monitor is provided.
	 * @see IResource#isLinked()
	 * @see IResource#ALLOW_MISSING_LOCAL
	 * @see IResource#REPLACE
	 * @see IResource#BACKGROUND_REFRESH
	 * @see IResource#HIDDEN
	 * @since 2.1
	 */
	void createLink(IPath localLocation, int updateFlags, IProgressMonitor monitor) throws CoreException;

	Creates a new folder resource as a member of this handle's parent resource.
The folder's contents will be located in the directory specified by the given
file system URI.  The given URI must be either absolute, or a relative URI
whose first path segment is the name of a workspace path variable.

The ALLOW_MISSING_LOCAL update flag controls how this
method deals with cases where the local file system directory to be linked does
not exist, or is relative to a workspace path variable that is not defined.
If ALLOW_MISSING_LOCAL is specified, the operation will succeed
even if the local directory is missing, or the path is relative to an
undefined variable. If ALLOW_MISSING_LOCAL is not specified, the
operation will fail in the case where the local file system directory does
not exist or the path is relative to an undefined variable.

 The IResource.REPLACE update flag controls how this method deals with cases where a resource of the same name as the prospective link already exists. If IResource.REPLACE is specified, then any existing resource with the same name is removed from the workspace to make way for creation of the link. This does not cause the underlying file system contents of that resource to be deleted. If IResource.REPLACE is not specified, this method will fail if an existing resource exists of the same name. 
 The IResource.BACKGROUND_REFRESH update flag controls how this method synchronizes the new resource with the filesystem. If this flag is specified, resources on disk will be synchronized in the background after the method returns. Child resources of the link may not be available until this background refresh completes. If this flag is not specified, resources are synchronized in the foreground before this method returns. 
 The IResource.HIDDEN update flag indicates that this resource should immediately be set as a hidden resource. Specifying this flag is equivalent to atomically calling IResource.setHidden(boolean) with a value of true immediately after creating the resource.


Update flags other than those listed above are ignored.


This method changes resources; these changes will be reported
in a subsequent resource change event, including an indication
that the folder has been added to its parent.


This method is long-running; progress and cancellation are provided
by the given progress monitor.

Params: location – a file system path where the folder should be linked
updateFlags – bit-wise or of update flag constants (IResource.ALLOW_MISSING_LOCAL, IResource.REPLACE, IResource.BACKGROUND_REFRESH, and IResource.HIDDEN)
monitor – a progress monitor, or null if progress
   reporting is not desired
Throws: CoreException – if this method fails. Reasons include:

 This resource already exists in the workspace.
 The workspace contains a resource of a different type
     at the same path as this resource.
 The parent of this resource does not exist.
 The parent of this resource is not an open project
 The name of this resource is not valid (according to
   IWorkspace.validateName).
 The corresponding location in the local file system does not exist, or
is relative to an undefined variable, and ALLOW_MISSING_LOCAL is
not specified.
 The corresponding location in the local file system is occupied
   by a file (as opposed to a directory).
 Resource changes are disallowed during certain types of resource change
      event notification.  See IResourceChangeEvent for more details.
The team provider for the project which contains this folder does not permit
      linked resources.
This folder's project contains a nature which does not permit linked resources.
OperationCanceledException – if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.
See Also: IResource.isLinked()
IResource.ALLOW_MISSING_LOCAL
IResource.REPLACE
IResource.BACKGROUND_REFRESH
IResource.HIDDEN
Since: 3.2/**
	 * Creates a new folder resource as a member of this handle's parent resource.
	 * The folder's contents will be located in the directory specified by the given
	 * file system URI.  The given URI must be either absolute, or a relative URI
	 * whose first path segment is the name of a workspace path variable.
	 * <p>
	 * The <code>ALLOW_MISSING_LOCAL</code> update flag controls how this
	 * method deals with cases where the local file system directory to be linked does
	 * not exist, or is relative to a workspace path variable that is not defined.
	 * If <code>ALLOW_MISSING_LOCAL</code> is specified, the operation will succeed
	 * even if the local directory is missing, or the path is relative to an
	 * undefined variable. If <code>ALLOW_MISSING_LOCAL</code> is not specified, the
	 * operation will fail in the case where the local file system directory does
	 * not exist or the path is relative to an undefined variable.
	 * </p>
	 * <p>
	 * The {@link IResource#REPLACE} update flag controls how this
	 * method deals with cases where a resource of the same name as the
	 * prospective link already exists. If {@link IResource#REPLACE}
	 * is specified, then any existing resource with the same name is removed
	 * from the workspace to make way for creation of the link.  This does <b>not</b>
	 * cause the underlying file system contents of that resource to be deleted.
	 * If {@link IResource#REPLACE} is not specified, this method will
	 * fail if an existing resource exists of the same name.
	 * </p>
	 * <p>
	 * The {@link IResource#BACKGROUND_REFRESH} update flag controls how
	 * this method synchronizes the new resource with the filesystem. If this flag is
	 * specified, resources on disk will be synchronized in the background after the
	 * method returns. Child resources of the link may not be available until
	 * this background refresh completes. If this flag is not specified, resources are
	 * synchronized in the foreground before this method returns.
	 * </p>
	 * <p>
	 * The {@link IResource#HIDDEN} update flag indicates that this resource
	 * should immediately be set as a hidden resource.  Specifying this flag
	 * is equivalent to atomically calling {@link IResource#setHidden(boolean)}
	 * with a value of <code>true</code> immediately after creating the resource.
	 * </p>
	 * <p>
	 * Update flags other than those listed above are ignored.
	 * </p>
	 * <p>
	 * This method changes resources; these changes will be reported
	 * in a subsequent resource change event, including an indication
	 * that the folder has been added to its parent.
	 * </p>
	 * <p>
	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor.
	 * </p>
	 *
	 * @param location a file system path where the folder should be linked
	 * @param updateFlags bit-wise or of update flag constants
	 *   ({@link IResource#ALLOW_MISSING_LOCAL}, {@link IResource#REPLACE}, {@link IResource#BACKGROUND_REFRESH}, and {@link IResource#HIDDEN})
	 * @param monitor a progress monitor, or <code>null</code> if progress
	 *    reporting is not desired
	 * @exception CoreException if this method fails. Reasons include:
	 * <ul>
	 * <li> This resource already exists in the workspace.</li>
	 * <li> The workspace contains a resource of a different type
	 *      at the same path as this resource.</li>
	 * <li> The parent of this resource does not exist.</li>
	 * <li> The parent of this resource is not an open project</li>
	 * <li> The name of this resource is not valid (according to
	 *    <code>IWorkspace.validateName</code>).</li>
	 * <li> The corresponding location in the local file system does not exist, or
	 * is relative to an undefined variable, and <code>ALLOW_MISSING_LOCAL</code> is
	 * not specified.</li>
	 * <li> The corresponding location in the local file system is occupied
	 *    by a file (as opposed to a directory).</li>
	 * <li> Resource changes are disallowed during certain types of resource change
	 *       event notification.  See <code>IResourceChangeEvent</code> for more details.</li>
	 * <li>The team provider for the project which contains this folder does not permit
	 *       linked resources.</li>
	 * <li>This folder's project contains a nature which does not permit linked resources.</li>
	 * </ul>
	 * @exception OperationCanceledException if the operation is canceled.
	 * Cancelation can occur even if no progress monitor is provided.
	 * @see IResource#isLinked()
	 * @see IResource#ALLOW_MISSING_LOCAL
	 * @see IResource#REPLACE
	 * @see IResource#BACKGROUND_REFRESH
	 * @see IResource#HIDDEN
	 * @since 3.2
	 */
	void createLink(URI location, int updateFlags, IProgressMonitor monitor) throws CoreException;

	Deletes this resource from the workspace.

This is a convenience method, fully equivalent to:

  delete((keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);


This method changes resources; these changes will be reported
in a subsequent resource change event, including an indication
that this folder has been removed from its parent.


This method is long-running; progress and cancellation are provided
by the given progress monitor.

Params: force – a flag controlling whether resources that are not
   in sync with the local file system will be tolerated
keepHistory – a flag controlling whether files under this folder
   should be stored in the workspace's local history
monitor – a progress monitor, or null if progress
   reporting is not desired
Throws: CoreException – if this method fails. Reasons include:

 This resource could not be deleted for some reason.
 This resource is out of sync with the local file system
     and force is false.
 Resource changes are disallowed during certain types of resource change
      event notification. See IResourceChangeEvent for more details.
OperationCanceledException – if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.
See Also: IResourceRuleFactory.deleteRule(IResource)
IResource.delete(int, IProgressMonitor)/**
	 * Deletes this resource from the workspace.
	 * <p>
	 * This is a convenience method, fully equivalent to:
	 * </p>
	 * <pre>
	 *   delete((keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);
	 * </pre>
	 * <p>
	 * This method changes resources; these changes will be reported
	 * in a subsequent resource change event, including an indication
	 * that this folder has been removed from its parent.
	 * </p>
	 * <p>
	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor.
	 * </p>
	 *
	 * @param force a flag controlling whether resources that are not
	 *    in sync with the local file system will be tolerated
	 * @param keepHistory a flag controlling whether files under this folder
	 *    should be stored in the workspace's local history
	 * @param monitor a progress monitor, or <code>null</code> if progress
	 *    reporting is not desired
	 * @exception CoreException if this method fails. Reasons include:
	 * <ul>
	 * <li> This resource could not be deleted for some reason.</li>
	 * <li> This resource is out of sync with the local file system
	 *      and <code>force</code> is <code>false</code>.</li>
	 * <li> Resource changes are disallowed during certain types of resource change
	 *       event notification. See <code>IResourceChangeEvent</code> for more details.</li>
	 * </ul>
	 * @exception OperationCanceledException if the operation is canceled.
	 * Cancelation can occur even if no progress monitor is provided.
	 *
	 * @see IResourceRuleFactory#deleteRule(IResource)
	 * @see IResource#delete(int,IProgressMonitor)
	 */
	void delete(boolean force, boolean keepHistory, IProgressMonitor monitor) throws CoreException;

	Returns a handle to the file with the given name in this folder.

This is a resource handle operation; neither the resource nor
the result need exist in the workspace.
The validation check on the resource name/path is not done
when the resource handle is constructed; rather, it is done
automatically as the resource is created.

Params: name – the string name of the member file
See Also: getFolder(String)
Returns: the (handle of the) member file/**
	 * Returns a handle to the file with the given name in this folder.
	 * <p>
	 * This is a resource handle operation; neither the resource nor
	 * the result need exist in the workspace.
	 * The validation check on the resource name/path is not done
	 * when the resource handle is constructed; rather, it is done
	 * automatically as the resource is created.
	 * </p>
	 *
	 * @param name the string name of the member file
	 * @return the (handle of the) member file
	 * @see #getFolder(String)
	 */
	IFile getFile(String name);

	Returns a handle to the folder with the given name in this folder.

This is a resource handle operation; neither the container
nor the result need exist in the workspace.
The validation check on the resource name/path is not done
when the resource handle is constructed; rather, it is done
automatically as the resource is created.

Params: name – the string name of the member folder
See Also: getFile(String)
Returns: the (handle of the) member folder/**
	 * Returns a handle to the folder with the given name in this folder.
	 * <p>
	 * This is a resource handle operation; neither the container
	 * nor the result need exist in the workspace.
	 * The validation check on the resource name/path is not done
	 * when the resource handle is constructed; rather, it is done
	 * automatically as the resource is created.
	 * </p>
	 *
	 * @param name the string name of the member folder
	 * @return the (handle of the) member folder
	 * @see #getFile(String)
	 */
	IFolder getFolder(String name);

	Moves this resource so that it is located at the given path.

This is a convenience method, fully equivalent to:

  move(destination, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);


This method changes resources; these changes will be reported
in a subsequent resource change event, including an indication
that this folder has been removed from its parent and a new folder
has been added to the parent of the destination.


This method is long-running; progress and cancellation are provided
by the given progress monitor.

Params: destination – the destination path
force – a flag controlling whether resources that are not
   in sync with the local file system will be tolerated
keepHistory – a flag controlling whether files under this folder
   should be stored in the workspace's local history
monitor – a progress monitor, or null if progress
   reporting is not desired
Throws: CoreException – if this resource could not be moved. Reasons include:

 This resource does not exist.
 This resource or one of its descendents is not local.
 The resource corresponding to the parent destination path does not exist.
 The resource corresponding to the parent destination path is a closed
     project.
 A resource at destination path does exist.
 A resource of a different type exists at the destination path.
 This resource or one of its descendents is out of sync with the local file system
     and force is false.
 The workspace and the local file system are out of sync
     at the destination resource or one of its descendents.
 Resource changes are disallowed during certain types of resource change
      event notification. See IResourceChangeEvent for more details.
OperationCanceledException – if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.
See Also: IResourceRuleFactory.moveRule(IResource, IResource)
IResource.move(IPath, int, IProgressMonitor)/**
	 * Moves this resource so that it is located at the given path.
	 * <p>
	 * This is a convenience method, fully equivalent to:
	 * </p>
	 * <pre>
	 *   move(destination, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);
	 * </pre>
	 * <p>
	 * This method changes resources; these changes will be reported
	 * in a subsequent resource change event, including an indication
	 * that this folder has been removed from its parent and a new folder
	 * has been added to the parent of the destination.
	 * </p>
	 * <p>
	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor.
	 * </p>
	 *
	 * @param destination the destination path
	 * @param force a flag controlling whether resources that are not
	 *    in sync with the local file system will be tolerated
	 * @param keepHistory a flag controlling whether files under this folder
	 *    should be stored in the workspace's local history
	 * @param monitor a progress monitor, or <code>null</code> if progress
	 *    reporting is not desired
	 * @exception CoreException if this resource could not be moved. Reasons include:
	 * <ul>
	 * <li> This resource does not exist.</li>
	 * <li> This resource or one of its descendents is not local.</li>
	 * <li> The resource corresponding to the parent destination path does not exist.</li>
	 * <li> The resource corresponding to the parent destination path is a closed
	 *      project.</li>
	 * <li> A resource at destination path does exist.</li>
	 * <li> A resource of a different type exists at the destination path.</li>
	 * <li> This resource or one of its descendents is out of sync with the local file system
	 *      and <code>force</code> is <code>false</code>.</li>
	 * <li> The workspace and the local file system are out of sync
	 *      at the destination resource or one of its descendents.</li>
	 * <li> Resource changes are disallowed during certain types of resource change
	 *       event notification. See <code>IResourceChangeEvent</code> for more details.</li>
	 * </ul>
	 * @exception OperationCanceledException if the operation is canceled.
	 * Cancelation can occur even if no progress monitor is provided.
	 *
	 * @see IResourceRuleFactory#moveRule(IResource, IResource)
	 * @see IResource#move(IPath,int,IProgressMonitor)
	 */
	void move(IPath destination, boolean force, boolean keepHistory, IProgressMonitor monitor) throws CoreException;
}

See Also:	getAdapterManager.getAdapterManager()
@noimplement	This interface is not intended to be implemented by clients.
@noextend	This interface is not intended to be extended by clients.

Params:	force – a flag controlling how to deal with resources that are not in sync with the local file system local – a flag controlling whether or not the folder will be local after the creation monitor – a progress monitor, or `null` if progress reporting is not desired
Throws:	CoreException – if this method fails. Reasons include: This resource already exists in the workspace. The workspace contains a resource of a different type at the same path as this resource. The parent of this resource does not exist. The parent of this resource is a project that is not open. The parent contains a resource of a different type at the same path as this resource. The parent of this resource is virtual, but this resource is not. The name of this resource is not valid (according to `IWorkspace.validateName`). The corresponding location in the local file system is occupied by a file (as opposed to a directory). The corresponding location in the local file system is occupied by a folder and `force` is `false`. Resource changes are disallowed during certain types of resource change event notification. See `IResourceChangeEvent` for more details. OperationCanceledException – if the operation is canceled. Cancelation can occur even if no progress monitor is provided.
See Also:	create(int, boolean, IProgressMonitor)

Params:	updateFlags – bit-wise or of update flag constants (`IResource.FORCE`, `IResource.DERIVED`, `IResource.TEAM_PRIVATE`) and `IResource.VIRTUAL`) local – a flag controlling whether or not the folder will be local after the creation monitor – a progress monitor, or `null` if progress reporting is not desired
Throws:	CoreException – if this method fails. Reasons include: This resource already exists in the workspace. The workspace contains a resource of a different type at the same path as this resource. The parent of this resource does not exist. The parent of this resource is a project that is not open. The parent contains a resource of a different type at the same path as this resource. The parent of this resource is virtual, but this resource is not. The name of this resource is not valid (according to `IWorkspace.validateName`). The corresponding location in the local file system is occupied by a file (as opposed to a directory). The corresponding location in the local file system is occupied by a folder and `FORCE` is not specified. Resource changes are disallowed during certain types of resource change event notification. See `IResourceChangeEvent` for more details. OperationCanceledException – if the operation is canceled. Cancelation can occur even if no progress monitor is provided.
See Also:	IResourceRuleFactory.createRule(IResource)
Since:	2.0

Params:	localLocation – a file system path where the folder should be linked updateFlags – bit-wise or of update flag constants (`IResource.ALLOW_MISSING_LOCAL`, `IResource.REPLACE`, `IResource.BACKGROUND_REFRESH`, and `IResource.HIDDEN`) monitor – a progress monitor, or `null` if progress reporting is not desired
Throws:	CoreException – if this method fails. Reasons include: This resource already exists in the workspace. The workspace contains a resource of a different type at the same path as this resource. The parent of this resource does not exist. The parent of this resource is not an open project The name of this resource is not valid (according to `IWorkspace.validateName`). The corresponding location in the local file system does not exist, or is relative to an undefined variable, and `ALLOW_MISSING_LOCAL` is not specified. The corresponding location in the local file system is occupied by a file (as opposed to a directory). Resource changes are disallowed during certain types of resource change event notification. See `IResourceChangeEvent` for more details. The team provider for the project which contains this folder does not permit linked resources. This folder's project contains a nature which does not permit linked resources. OperationCanceledException – if the operation is canceled. Cancelation can occur even if no progress monitor is provided.
See Also:	IResource.isLinked() IResource.ALLOW_MISSING_LOCAL IResource.REPLACE IResource.BACKGROUND_REFRESH IResource.HIDDEN
Since:	2.1

Params:	location – a file system path where the folder should be linked updateFlags – bit-wise or of update flag constants (`IResource.ALLOW_MISSING_LOCAL`, `IResource.REPLACE`, `IResource.BACKGROUND_REFRESH`, and `IResource.HIDDEN`) monitor – a progress monitor, or `null` if progress reporting is not desired
Throws:	CoreException – if this method fails. Reasons include: This resource already exists in the workspace. The workspace contains a resource of a different type at the same path as this resource. The parent of this resource does not exist. The parent of this resource is not an open project The name of this resource is not valid (according to `IWorkspace.validateName`). The corresponding location in the local file system does not exist, or is relative to an undefined variable, and `ALLOW_MISSING_LOCAL` is not specified. The corresponding location in the local file system is occupied by a file (as opposed to a directory). Resource changes are disallowed during certain types of resource change event notification. See `IResourceChangeEvent` for more details. The team provider for the project which contains this folder does not permit linked resources. This folder's project contains a nature which does not permit linked resources. OperationCanceledException – if the operation is canceled. Cancelation can occur even if no progress monitor is provided.
See Also:	IResource.isLinked() IResource.ALLOW_MISSING_LOCAL IResource.REPLACE IResource.BACKGROUND_REFRESH IResource.HIDDEN
Since:	3.2

Params:	force – a flag controlling whether resources that are not in sync with the local file system will be tolerated keepHistory – a flag controlling whether files under this folder should be stored in the workspace's local history monitor – a progress monitor, or `null` if progress reporting is not desired
Throws:	CoreException – if this method fails. Reasons include: This resource could not be deleted for some reason. This resource is out of sync with the local file system and `force` is `false`. Resource changes are disallowed during certain types of resource change event notification. See `IResourceChangeEvent` for more details. OperationCanceledException – if the operation is canceled. Cancelation can occur even if no progress monitor is provided.
See Also:	IResourceRuleFactory.deleteRule(IResource) IResource.delete(int, IProgressMonitor)

Params:	name – the string name of the member file
See Also:	getFolder(String)
Returns:	the (handle of the) member file

Params:	name – the string name of the member folder
See Also:	getFile(String)
Returns:	the (handle of the) member folder

Params:	destination – the destination path force – a flag controlling whether resources that are not in sync with the local file system will be tolerated keepHistory – a flag controlling whether files under this folder should be stored in the workspace's local history monitor – a progress monitor, or `null` if progress reporting is not desired
Throws:	CoreException – if this resource could not be moved. Reasons include: This resource does not exist. This resource or one of its descendents is not local. The resource corresponding to the parent destination path does not exist. The resource corresponding to the parent destination path is a closed project. A resource at destination path does exist. A resource of a different type exists at the destination path. This resource or one of its descendents is out of sync with the local file system and `force` is `false`. The workspace and the local file system are out of sync at the destination resource or one of its descendents. Resource changes are disallowed during certain types of resource change event notification. See `IResourceChangeEvent` for more details. OperationCanceledException – if the operation is canceled. Cancelation can occur even if no progress monitor is provided.
See Also:	IResourceRuleFactory.moveRule(IResource, IResource) IResource.move(IPath, int, IProgressMonitor)

/

org.eclipse.platform/ org.eclipse.core.resources/ 3.13.600/ org/eclipse/core/resources/IFolder.java