org.eclipse.core.resources
Interface IFolder

All Superinterfaces:

IAdaptable, IContainer, IResource

public interface IFolder

extends IContainer, IAdaptable

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 placeholders for folders whose properties have not yet been fetched from a repository.

This interface is not intended to be implemented by clients.

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

See Also:

Platform.getAdapterManager()

Field Summary

Fields inherited from interface org.eclipse.core.resources.IContainer

INCLUDE_PHANTOMS, INCLUDE_TEAM_PRIVATE_MEMBERS

Fields inherited from interface org.eclipse.core.resources.IResource

ALWAYS_DELETE_PROJECT_CONTENT, DEPTH_INFINITE, DEPTH_ONE, DEPTH_ZERO, FILE, FOLDER, FORCE, KEEP_HISTORY, NEVER_DELETE_PROJECT_CONTENT, NONE, NULL_STAMP, PROJECT, ROOT

Method Summary

void	create(boolean force, boolean local, IProgressMonitor monitor) Creates a new folder resource as a member of this handle's parent resource.
void	create(int updateFlags, boolean local, IProgressMonitor monitor) Creates a new folder resource as a member of this handle's parent resource.
void	delete(boolean force, boolean keepHistory, IProgressMonitor monitor) Deletes this resource from the workspace.
IFile	getFile(String name) Returns a handle to the file with the given name in this folder.
IFolder	getFolder(String name) Returns a handle to the folder with the given name in this folder.
void	move(IPath destination, boolean force, boolean keepHistory, IProgressMonitor monitor) Moves this resource so that it is located at the given path.

Methods inherited from interface org.eclipse.core.resources.IContainer

exists, findDeletedMembersWithHistory, findMember, findMember, findMember, findMember, getFile, getFolder, members, members, members

Methods inherited from interface org.eclipse.core.resources.IResource

accept, accept, accept, clearHistory, copy, copy, copy, copy, createMarker, delete, delete, deleteMarkers, equals, exists, findMarker, findMarkers, getFileExtension, getFullPath, getLocation, getMarker, getModificationStamp, getName, getParent, getPersistentProperty, getProject, getProjectRelativePath, getSessionProperty, getType, getWorkspace, isAccessible, isDerived, isLocal, isPhantom, isReadOnly, isSynchronized, isTeamPrivateMember, move, move, move, move, refreshLocal, setDerived, setLocal, setPersistentProperty, setReadOnly, setSessionProperty, setTeamPrivateMember, touch

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

create

public void create(boolean force,
                   boolean local,
                   IProgressMonitor monitor)
            throws CoreException

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.

Parameters:

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 and cancellation are 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 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.

See Also:

create(int,boolean,IProgressMonitor)

create

public 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 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.

Update flags other than FORCE 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.

Parameters:

updateFlags - bit-wise or of update flag constants (only FORCE is relevant here)

local - a flag controlling whether or not the folder will be local after the creation

monitor - a progress monitor, or null if progress reporting and cancellation are 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 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.

Since:

2.0

delete

public void delete(boolean force,
                   boolean keepHistory,
                   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.

Parameters:

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 and cancellation are 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.

See Also:

IResource.delete(int,IProgressMonitor)

getFile

public IFile getFile(String name)

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.

Parameters:

name - the string name of the member file

Returns:

the (handle of the) member file

See Also:

getFolder(java.lang.String)

getFolder

public IFolder getFolder(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.

Parameters:

name - the string name of the member folder

Returns:

the (handle of the) member folder

See Also:

getFile(java.lang.String)

move

public void move(IPath destination,
                 boolean force,
                 boolean keepHistory,
                 IProgressMonitor monitor)
          throws CoreException

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.

Parameters:

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 and cancellation are 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.

See Also:

IResource.move(IPath,int,IProgressMonitor)