public interface IWorkspaceRoot extends IContainer, IAdaptable
Workspace roots implement the IAdaptable
interface;
extensions are managed by the platform's adapter manager.
Platform.getAdapterManager()
DO_NOT_CHECK_EXISTENCE, EXCLUDE_DERIVED, INCLUDE_HIDDEN, INCLUDE_PHANTOMS, INCLUDE_TEAM_PRIVATE_MEMBERS
ALLOW_MISSING_LOCAL, ALWAYS_DELETE_PROJECT_CONTENT, AVOID_NATURE_CONFIG, BACKGROUND_REFRESH, CHECK_ANCESTORS, DEPTH_INFINITE, DEPTH_ONE, DEPTH_ZERO, DERIVED, FILE, FOLDER, FORCE, HIDDEN, KEEP_HISTORY, NEVER_DELETE_PROJECT_CONTENT, NONE, NULL_STAMP, PROJECT, REPLACE, ROOT, SHALLOW, TEAM_PRIVATE, VIRTUAL
Modifier and Type | Method and Description |
---|---|
void |
delete(boolean deleteContent,
boolean force,
IProgressMonitor monitor)
Deletes everything in the workspace except the workspace root resource
itself.
|
IContainer[] |
findContainersForLocation(IPath location)
Deprecated.
use
findContainersForLocationURI(URI) instead |
IContainer[] |
findContainersForLocationURI(URI location)
Returns the handles to all the resources (workspace root, project,
folder) in the workspace which are mapped to the given URI.
|
IContainer[] |
findContainersForLocationURI(URI location,
int memberFlags)
Returns the handles to all the resources (workspace root, project,
folder) in the workspace which are mapped to the given URI.
|
IFile[] |
findFilesForLocation(IPath location)
Deprecated.
use
findFilesForLocationURI(URI) instead |
IFile[] |
findFilesForLocationURI(URI location)
Returns the handles of all files that are mapped to the given URI.
|
IFile[] |
findFilesForLocationURI(URI location,
int memberFlags)
Returns the handles of all files that are mapped to the given URI.
|
IContainer |
getContainerForLocation(IPath location)
Returns a handle to the workspace root, project or folder
which is mapped to the given path
in the local file system, or
null if none. |
IFile |
getFileForLocation(IPath location)
Returns a handle to the file which is mapped to the given path
in the local file system, or
null if none. |
IProject |
getProject(String name)
Returns a handle to the project resource with the given name
which is a child of this root.
|
IProject[] |
getProjects()
Returns the collection of projects which exist under this root.
|
IProject[] |
getProjects(int memberFlags)
Returns the collection of projects which exist under this root.
|
createFilter, exists, findDeletedMembersWithHistory, findMember, findMember, findMember, findMember, getDefaultCharset, getDefaultCharset, getFile, getFilters, getFolder, members, members, members, setDefaultCharset, setDefaultCharset
accept, accept, accept, accept, accept, clearHistory, copy, copy, copy, copy, createMarker, createProxy, delete, delete, deleteMarkers, equals, exists, findMarker, findMarkers, findMaxProblemSeverity, getFileExtension, getFullPath, getLocalTimeStamp, getLocation, getLocationURI, getMarker, getModificationStamp, getName, getParent, getPathVariableManager, getPersistentProperties, getPersistentProperty, getProject, getProjectRelativePath, getRawLocation, getRawLocationURI, getResourceAttributes, getSessionProperties, getSessionProperty, getType, getWorkspace, isAccessible, isDerived, isDerived, isHidden, isHidden, isLinked, isLinked, isLocal, isPhantom, isReadOnly, isSynchronized, isTeamPrivateMember, isTeamPrivateMember, isVirtual, move, move, move, move, refreshLocal, revertModificationStamp, setDerived, setDerived, setHidden, setLocal, setLocalTimeStamp, setPersistentProperty, setReadOnly, setResourceAttributes, setSessionProperty, setTeamPrivateMember, touch
getAdapter
contains, isConflicting
void delete(boolean deleteContent, boolean force, IProgressMonitor monitor) throws CoreException
This is a convenience method, fully equivalent to:
delete( (deleteContent ? IResource.ALWAYS_DELETE_PROJECT_CONTENT : IResource.NEVER_DELETE_PROJECT_CONTENT ) | (force ? FORCE : IResource.NONE), monitor);
This method changes resources; these changes will be reported in a subsequent resource change event.
This method is long-running; progress and cancellation are provided by the given progress monitor.
deleteContent
- a flag controlling how whether content is
aggressively deletedforce
- a flag controlling whether resources that are not
in sync with the local file system will be toleratedmonitor
- a progress monitor, or null
if progress
reporting is not desiredCoreException
- if this method fails. Reasons include:
IResourceChangeEvent
for more details.OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided.IResource.delete(int,IProgressMonitor)
IContainer[] findContainersForLocation(IPath location)
findContainersForLocationURI(URI)
instead
If the path maps to the platform working location, the returned object
will be a single element array consisting of an object of type
ROOT
.
If the path maps to a project, the resulting array will contain a
resource of type PROJECT
, along with any linked folders that
share the same location. Otherwise the resulting array will contain
folders (type FOLDER
).
The path should be absolute; a relative path will be treated as absolute. The path segments need not be valid names; a trailing separator is ignored. The resulting resources may not currently exist.
The result will omit team private members and hidden resources. The result will omit resources within team private members or hidden containers.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
location
- a path in the local file systemIContainer[] findContainersForLocationURI(URI location)
If the path maps to the platform working location, the returned object
will be a single element array consisting of an object of type
ROOT
.
If the path maps to a project, the resulting array will contain a
resource of type PROJECT
, along with any linked folders that
share the same location. Otherwise the resulting array will contain
folders (type FOLDER
).
The URI must be absolute; its segments need not be valid names; a trailing separator is ignored. The resulting resources may not currently exist.
The result will omit team private members and hidden resources. The result will omit resources within team private member sor hidden containers.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
This is a convenience method, fully equivalent to
findContainersForLocationURI(location, IResource.NONE)
.
location
- a URI path into some file systemIContainer[] findContainersForLocationURI(URI location, int memberFlags)
If the IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
flag is specified in the
member flags, team private members will be included along with the
others. If the IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
flag is not
specified (recommended), the result will omit any team private member
resources.
If the IContainer.INCLUDE_HIDDEN
flag is specified in the member flags,
hidden members will be included along with the others. If the
IContainer.INCLUDE_HIDDEN
flag is not specified (recommended), the result
will omit any hidden member resources.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
location
- a URI path into some file systemmemberFlags
- bit-wise or of member flag constants (
IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
and IContainer.INCLUDE_HIDDEN
)
indicating which members are of interestIFile[] findFilesForLocation(IPath location)
findFilesForLocationURI(URI)
insteadThe result will omit any team private member and hidden resources. The result will omit resources within team private member or hidden containers.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
location
- a path in the local file systemIFile[] findFilesForLocationURI(URI location)
The result will omit any team private member and hidden resources. The result will omit resources within team private member or hidden containers.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
This is a convenience method, fully equivalent to
findFilesForLocationURI(location, IResource.NONE)
.
location
- a URI path into some file systemIFile[] findFilesForLocationURI(URI location, int memberFlags)
If the IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
flag is specified in the
member flags, team private members will be included along with the
others. If the IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
flag is not
specified (recommended), the result will omit any team private member
resources.
If the IContainer.INCLUDE_HIDDEN
flag is specified in the member flags,
hidden members will be included along with the others. If the
IContainer.INCLUDE_HIDDEN
flag is not specified (recommended), the result
will omit any hidden member resources.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
location
- a URI path into some file systemmemberFlags
- bit-wise or of member flag constants (
IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
and IContainer.INCLUDE_HIDDEN
)
indicating which members are of interestIContainer getContainerForLocation(IPath location)
null
if none.
If the path maps to the platform working location, the returned object
will be of type ROOT
. If the path maps to a
project, the resulting object will be
of type PROJECT
; otherwise the resulting object
will be a folder (type FOLDER
).
The path should be absolute; a relative path will be treated as
absolute. The path segments need not be valid names; a trailing separator is ignored.
The resulting resource may not currently exist.
This method returns null when the given file system location is not equal to or under the location of any existing project in the workspace, or equal to the location of the platform working location.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
Warning: This method ignores linked resources and their children. Since
linked resources may overlap other resources, a unique mapping from a
file system location to a single resource is not guaranteed. To find all
resources for a given location, including linked resources, use the method
findContainersForLocation
.
location
- a path in the local file systemnull
if noneIFile getFileForLocation(IPath location)
null
if none.
The path should be absolute; a relative path will be treated as
absolute. The path segments need not be valid names.
The resulting file may not currently exist.
This method returns null when the given file system location is not under the location of any existing project in the workspace.
The result will also omit resources that are explicitly excluded from the workspace according to existing resource filters.
Warning: This method ignores linked resources and their children. Since
linked resources may overlap other resources, a unique mapping from a
file system location to a single resource is not guaranteed. To find all
resources for a given location, including linked resources, use the method
findFilesForLocation
.
location
- a path in the local file systemnull
if noneIProject getProject(String name)
IPath.isValidSegment(String)
.
Note: This method deals exclusively with resource handles, independent of whether the resources exist in the workspace. With the exception of validating that the name is a valid path segment, validation checking of the project name is not done when the project handle is constructed; rather, it is done automatically as the project is created.
name
- the name of the projectgetProjects()
IProject[] getProjects()
This is a convenience method, fully equivalent to getProjects(IResource.NONE)
.
Hidden projects are not included.
getProject(String)
,
IResource.isHidden()
IProject[] getProjects(int memberFlags)
If the IContainer.INCLUDE_HIDDEN
flag is specified in the member flags, hidden
projects will be included along with the others. If the IContainer.INCLUDE_HIDDEN
flag
is not specified (recommended), the result will omit any hidden projects.
memberFlags
- bit-wise or of member flag constants indicating which
projects are of interest (only IContainer.INCLUDE_HIDDEN
is currently applicable)getProject(String)
,
IResource.isHidden()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.