|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The workspace analog of file system files and directories. There are exactly four types of resource: files, folders, projects and the workspace root.
File resources are similar to files in that they hold data directly. Folder resources are analogous to directories in that they hold other resources but cannot directly hold data. Project resources group files and folders into reusable clusters. The workspace root is the top level resource under which all others reside.
Features of resources:
IResource
objects are handles to state maintained
by a workspace. That is, resource objects do not actually contain data
themselves but rather represent resource state and give it behavior. Programmers
are free to manipulate handles for resources that do not exist in a workspace
but must keep in mind that some methods and operations require that an actual
resource be available.This interface is not intended to be implemented by clients.
Resources implement the IAdaptable
interface;
extensions are managed by the platform's adapter manager.
IWorkspace
,
Platform.getAdapterManager()
Field Summary | |
static int |
ALWAYS_DELETE_PROJECT_CONTENT
Update flag constant (bit mask value 4) indicating that the operation should delete the files and folders of a project. |
static int |
DEPTH_INFINITE
Depth constant (value 2) indicating this resource and its direct and indirect members at any depth. |
static int |
DEPTH_ONE
Depth constant (value 1) indicating this resource and its direct members. |
static int |
DEPTH_ZERO
Depth constant (value 0) indicating this resource, but not any of its members. |
static int |
FILE
Type constant (bit mask value 1) which identifies file resources. |
static int |
FOLDER
Type constant (bit mask value 2) which identifies folder resources. |
static int |
FORCE
Update flag constant (bit mask value 1) indicating that the operation if to proceed even if the resource is out of sync with the local file system. |
static int |
KEEP_HISTORY
Update flag constant (bit mask value 2) indicating that the operation should maintain local history by taking snapshots of the contents of files just before being overwritten or deleted. |
static int |
NEVER_DELETE_PROJECT_CONTENT
Update flag constant (bit mask value 4) indicating that the operation should preserve the files and folders of a project. |
static int |
NONE
General purpose zero-valued bit mask constant. |
static int |
NULL_STAMP
Modification stamp constant (value -1) indicating no modification stamp is available. |
static int |
PROJECT
Type constant (bit mask value 4) which identifies project resources. |
static int |
ROOT
Type constant (bit mask value 8) which identifies the root resource. |
Method Summary | |
void |
accept(IResourceVisitor visitor)
Accepts the given visitor. |
void |
accept(IResourceVisitor visitor,
int depth,
boolean includePhantoms)
Accepts the given visitor. |
void |
accept(IResourceVisitor visitor,
int depth,
int memberFlags)
Accepts the given visitor. |
void |
clearHistory(IProgressMonitor monitor)
Removes the local history of this resource and its descendants. |
void |
copy(IPath destination,
boolean force,
IProgressMonitor monitor)
Makes a copy of this resource at the given path. |
void |
copy(IPath destination,
int updateFlags,
IProgressMonitor monitor)
Makes a copy of this resource at the given path. |
void |
copy(IProjectDescription description,
boolean force,
IProgressMonitor monitor)
Makes a copy of this project using the given project description. |
void |
copy(IProjectDescription description,
int updateFlags,
IProgressMonitor monitor)
Makes a copy of this project using the given project description. |
IMarker |
createMarker(String type)
Creates and returns the marker with the specified type on this resource. |
void |
delete(boolean force,
IProgressMonitor monitor)
Deletes this resource from the workspace. |
void |
delete(int updateFlags,
IProgressMonitor monitor)
Deletes this resource from the workspace. |
void |
deleteMarkers(String type,
boolean includeSubtypes,
int depth)
Deletes all markers on this resource of the given type, and, optionally, deletes such markers from its children. |
boolean |
equals(Object other)
Compares two objects for equality; for resources, equality is defined in terms of their handles: same resource type, equal full paths, and identical workspaces. |
boolean |
exists()
Returns whether this resource exists in the workspace. |
IMarker |
findMarker(long id)
Returns the marker with the specified id on this resource, Returns null if there is no matching marker. |
IMarker[] |
findMarkers(String type,
boolean includeSubtypes,
int depth)
Returns all markers of the specified type on this resource, and, optionally, on its children. |
String |
getFileExtension()
Returns the file extension portion of this resource's name, or null if it does not have one. |
IPath |
getFullPath()
Returns the full, absolute path of this resource relative to the workspace. |
IPath |
getLocation()
Returns the absolute path in the local file system to this resource, or null if no path can be determined. |
IMarker |
getMarker(long id)
Returns a marker handle with the given id on this resource. |
long |
getModificationStamp()
Returns a non-negative modification stamp, or NULL_STAMP if
the resource does not exist or is not local or is not accessible. |
String |
getName()
Returns the name of this resource. |
IContainer |
getParent()
Returns the resource which is the parent of this resource, or null if it has no parent (that is, this
resource is the workspace root). |
String |
getPersistentProperty(QualifiedName key)
Returns the value of the persistent property of this resource identified by the given key, or null if this resource has no such property. |
IProject |
getProject()
Returns the project which contains this resource. |
IPath |
getProjectRelativePath()
Returns a relative path of this resource with respect to its project. |
Object |
getSessionProperty(QualifiedName key)
Returns the value of the session property of this resource identified by the given key, or null if this resource has no such property. |
int |
getType()
Returns the type of this resource. |
IWorkspace |
getWorkspace()
Returns the workspace which manages this resource. |
boolean |
isAccessible()
Returns whether this resource is accessible. |
boolean |
isDerived()
Returns whether this resource subtree is marked as derived. |
boolean |
isLocal(int depth)
Returns whether this resource and its members (to the specified depth) are expected to have their contents (and properties) available locally. |
boolean |
isPhantom()
Returns whether this resource is a phantom resource. |
boolean |
isReadOnly()
Returns whether this resource is marked as read-only in the file system. |
boolean |
isSynchronized(int depth)
Returns whether this resource and its descendants to the given depth are considered to be in sync with the local file system. |
boolean |
isTeamPrivateMember()
Returns whether this resource is a team private member of its parent container. |
void |
move(IPath destination,
boolean force,
IProgressMonitor monitor)
Moves this resource so that it is located at the given path. |
void |
move(IPath destination,
int updateFlags,
IProgressMonitor monitor)
Moves this resource so that it is located at the given path. |
void |
move(IProjectDescription description,
boolean force,
boolean keepHistory,
IProgressMonitor monitor)
Renames or relocates this project so that it is the project specified by the given project description. |
void |
move(IProjectDescription description,
int updateFlags,
IProgressMonitor monitor)
Renames or relocates this project so that it is the project specified by the given project description. |
void |
refreshLocal(int depth,
IProgressMonitor monitor)
Refreshes the resource hierarchy from this resource and its children (to the specified depth) relative to the local file system. |
void |
setDerived(boolean isDerived)
Sets whether this resource subtree is marked as derived. |
void |
setLocal(boolean flag,
int depth,
IProgressMonitor monitor)
Set whether or not this resource and its members (to the specified depth) are expected to have their contents (and properties) available locally. |
void |
setPersistentProperty(QualifiedName key,
String value)
Sets the value of the persistent property of this resource identified by the given key. |
void |
setReadOnly(boolean readOnly)
Sets or unsets this resource as read-only in the file system. |
void |
setSessionProperty(QualifiedName key,
Object value)
Sets the value of the session property of this resource identified by the given key. |
void |
setTeamPrivateMember(boolean isTeamPrivate)
Sets whether this resource subtree is a team private member of its parent container. |
void |
touch(IProgressMonitor monitor)
Marks this resource as having changed even though its content may not have changed. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Field Detail |
public static final int FILE
getType()
,
IFile
,
Constant Field Valuespublic static final int FOLDER
getType()
,
IFolder
,
Constant Field Valuespublic static final int PROJECT
getType()
,
IProject
,
Constant Field Valuespublic static final int ROOT
getType()
,
IWorkspaceRoot
,
Constant Field Valuespublic static final int DEPTH_ZERO
public static final int DEPTH_ONE
public static final int DEPTH_INFINITE
public static final int FORCE
public static final int KEEP_HISTORY
IFile.getHistory(org.eclipse.core.runtime.IProgressMonitor)
,
Constant Field Valuespublic static final int ALWAYS_DELETE_PROJECT_CONTENT
Deleting a project that is open ordinarily deletes all its files and folders,
whereas deleting a project that is closed retains its files and folders.
Specifying ALWAYS_DELETE_PROJECT_CONTENT
indicates that the contents
of a project are to be deleted regardless of whether the project is open or closed
at the time; specifying NEVER_DELETE_PROJECT_CONTENT
indicates that
the contents of a project are to be retained regardless of whether the project
is open or closed at the time.
NEVER_DELETE_PROJECT_CONTENT
,
Constant Field Valuespublic static final int NEVER_DELETE_PROJECT_CONTENT
Deleting a project that is open ordinarily deletes all its files and folders,
whereas deleting a project that is closed retains its files and folders.
Specifying ALWAYS_DELETE_PROJECT_CONTENT
indicates that the contents
of a project are to be deleted regardless of whether the project is open or closed
at the time; specifying NEVER_DELETE_PROJECT_CONTENT
indicates that
the contents of a project are to be retained regardless of whether the project
is open or closed at the time.
ALWAYS_DELETE_PROJECT_CONTENT
,
Constant Field Valuespublic static final int NULL_STAMP
getModificationStamp()
,
Constant Field Valuespublic static final int NONE
Example usage:
delete(IResource.NONE, null)
Method Detail |
public void accept(IResourceVisitor visitor) throws CoreException
visit
method is called with this
resource. If the visitor returns true
, this method
visits this resource's members.
This is a convenience method, fully equivalent to
accept(visitor,IResource.NONE,DEPTH_INFINITE)
.
visitor
- the visitor
CoreException
- if this method fails. Reasons include:
IResourceVisitor.visit(org.eclipse.core.resources.IResource)
,
accept(IResourceVisitor,int,int)
public void accept(IResourceVisitor visitor, int depth, boolean includePhantoms) throws CoreException
visit
method is called with this
resource. If the visitor returns false
,
this resource's members are not visited.
The subtree under the given resource is traversed to the supplied depth.
This is a convenience method, fully equivalent to:
accept(visitor, depth, includePhantoms ? INCLUDE_PHANTOMS : IResource.NONE);
visitor
- the visitordepth
- the depth to which members of this resource should be
visited. One of DEPTH_ZERO
, DEPTH_ONE
,
or DEPTH_INFINITE
.includePhantoms
- true
if phantom resources are
of interest; false
if phantom resources are not of
interest.
CoreException
- if this request fails. Reasons include:
includePhantoms
is false
and
this resource does not exist.includePhantoms
is true
and
this resource does not exist and is not a phantom.isPhantom()
,
IResourceVisitor.visit(org.eclipse.core.resources.IResource)
,
DEPTH_ZERO
,
DEPTH_ONE
,
DEPTH_INFINITE
,
accept(IResourceVisitor,int,int)
public void accept(IResourceVisitor visitor, int depth, int memberFlags) throws CoreException
visit
method is called with this
resource. If the visitor returns false
,
this resource's members are not visited.
The subtree under the given resource is traversed to the supplied depth.
If the INCLUDE_PHANTOMS
flag is not specified in the member
flags (recommended), only member resources that exists will be visited.
If the INCLUDE_PHANTOMS
flag is specified, the visit will
also include any phantom member resource that the workspace is keeping track of.
If the INCLUDE_TEAM_PRIVATE_MEMBERS
flag is not specified
(recommended), team private members will not be visited. If the
INCLUDE_TEAM_PRIVATE_MEMBERS
flag is specified in the member
flags, team private member resources are visited as well.
visitor
- the visitordepth
- the depth to which members of this resource should be
visited. One of DEPTH_ZERO
, DEPTH_ONE
,
or DEPTH_INFINITE
.memberFlags
- bit-wise or of member flag constants
(IContainer.INCLUDE_PHANTOMS
and INCLUDE_TEAM_PRIVATE_MEMBERS
)
indicating which members are of interest
CoreException
- if this request fails. Reasons include:
INCLUDE_PHANTOMS
flag is not specified and
this resource does not exist.INCLUDE_PHANTOMS
flag is not specified and
this resource is a project that is not open.IContainer.INCLUDE_PHANTOMS
,
IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
,
isPhantom()
,
isTeamPrivateMember()
,
DEPTH_ZERO
,
DEPTH_ONE
,
DEPTH_INFINITE
,
IResourceVisitor.visit(org.eclipse.core.resources.IResource)
public void clearHistory(IProgressMonitor monitor) throws CoreException
This operation is long-running; progress and cancellation are provided by the given progress monitor.
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
public void copy(IProjectDescription description, boolean force, IProgressMonitor monitor) throws CoreException
This is a convenience method, fully equivalent to:
copy(description, (force ? FORCE : IResource.NONE), monitor);
This operation changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource copy has been added to its new parent.
This operation is long-running; progress and cancellation are provided by the given progress monitor.
description
- the destination project descriptionforce
- 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 and cancellation are not desired
CoreException
- if this resource could not be copied. Reasons include:
force
is false
.public void copy(IPath destination, boolean force, IProgressMonitor monitor) throws CoreException
This is a convenience method, fully equivalent to:
copy(destination, (force ? FORCE : IResource.NONE), monitor);
This operation changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource copy has been added to its new parent.
This operation is long-running; progress and cancellation are provided by the given progress monitor.
destination
- the destination pathforce
- 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 and cancellation are not desired
CoreException
- if this resource could not be copied. Reasons include:
force
is false
.public void copy(IProjectDescription description, int updateFlags, IProgressMonitor monitor) throws CoreException
When a resource is copied, its persistent properties are copied with it. Session properties and markers are not copied.
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 copy resources that are in sync with the corresponding files and
directories in the local file system; it will fail if it
encounters a resource that is out of sync with the file system.
However, if FORCE
is specified, the method
copies all corresponding files and directories from the local
file system, including ones that have been recently updated or created.
Note that in both settings of the FORCE
flag,
the operation fails if the newly created resources in the
workspace would be out of sync with the local file system;
this ensures files in the file system cannot be accidentally
overwritten.
Update flags other than FORCE
are ignored.
This operation changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource copy has been added to its new parent.
This operation is long-running; progress and cancellation are provided by the given progress monitor.
description
- the destination project descriptionupdateFlags
- bit-wise or of update flag constants
(only FORCE
is relevant here)monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this resource could not be copied. Reasons include:
FORCE
is not specified.public void copy(IPath destination, int updateFlags, IProgressMonitor monitor) throws CoreException
The supplied path may be absolute or relative. Absolute paths fully specify the new location for the resource, including its project. Relative paths are considered to be relative to the container of the resource being copied. A trailing separator is ignored.
Calling this method with a one segment absolute destination path is equivalent to calling:
copy(workspace.newProjectDescription(folder.getName()),updateFlags,monitor);
When a resource is copied, its persistent properties are copied with it. Session properties and markers are not copied.
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 copy resources that are in sync with the corresponding files and
directories in the local file system; it will fail if it
encounters a resource that is out of sync with the file system.
However, if FORCE
is specified, the method
copies all corresponding files and directories from the local
file system, including ones that have been recently updated or created.
Note that in both settings of the FORCE
flag,
the operation fails if the newly created resources in the
workspace would be out of sync with the local file system;
this ensures files in the file system cannot be accidentally
overwritten.
Update flags other than FORCE
are ignored.
This operation changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource copy has been added to its new parent.
This operation is long-running; progress and cancellation are provided by the given progress monitor.
destination
- the destination pathupdateFlags
- bit-wise or of update flag constants
(only FORCE
is relevant here)monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this resource could not be copied. Reasons include:
FORCE
is not specified.FORCE
public IMarker createMarker(String type) throws CoreException
org.eclipse.core.resources.markers
extension
point.
type
- the type of the marker to create
CoreException
- if this method fails. Reasons include:
public void delete(boolean force, IProgressMonitor monitor) throws CoreException
This is a convenience method, fully equivalent to:
delete(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.
force
- 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 and cancellation are not desired
CoreException
- if this method fails. Reasons include:
force
is false
.delete(int,IProgressMonitor)
public void delete(int updateFlags, IProgressMonitor monitor) throws CoreException
Deleting a resource also deletes its contents from the local file system. In the case of a file or folder resource, the corresponding file or directory in the local file system is deleted. Deleting an open project recursively deletes its members; deleting a closed project just gets rid of the project itself (closed projects have no members); files in the project's local content area are retained; referenced projects are unaffected. Deleting the workspace root deletes all projects from the workspace and all properties, markers, etc. from the root. The root itself is not deleted though its properties and markers are deleted.
Deleting a resource also deletes its session and persistent properties and markers.
Deleting a non-project resource which has sync information converts the resource to a phantom and retains the sync information for future use.
Deleting the workspace root resource recursively deletes all projects, and removes all markers, properties, sync info and other data related to the workspace root; the root resource itself is not deleted, however.
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.
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 delete files and directories in the local file system that correspond
to, and are in sync with, resources in the workspace; it will fail if it
encounters a file or directory in the file system that is out of sync with the
workspace. This option ensures there is no unintended data loss; it is
the recommended setting.
However, if FORCE
is specified, the method will ruthlessly
attempt to delete corresponding files and directories in the local
file system, including ones that have been recently updated or created.
The KEEP_HISTORY
update flag controls whether or not
file that are about to be deleted from the local file system have their
current contents saved in the workspace's local history. The local history
mechanism serves as a safety net to help the user recover from mistakes that
might otherwise result in data loss. Specifying KEEP_HISTORY
is recommended except in circumstances where past states of the files are of
no conceivable interested to the user. Note that local history is maintained
with each individual project, and gets discarded when a project is deleted
from the workspace. Hence KEEP_HISTORY
is only really applicable
when deleting files and folders, but not projects.
The ALWAYS_DELETE_PROJECT_CONTENTS
update flag controls how project
deletions are handled. If ALWAYS_DELETE_PROJECT_CONTENTS
is specified,
then the files and folders in a project's local content area are deleted,
regardless of whether the project is open or closed; FORCE
is
assumed regardless of whether it is specified.
If NEVER_DELETE_PROJECT_CONTENTS
is specified, then the files and
folders in a project's local content area are retained, regardless of whether
the project is open or closed; the FORCE
flag is ignored.
If neither of these flags is specified, files and folders in a project's local
content area from open projects (subject to the FORCE
flag), but never
from closed projects.
updateFlags
- bit-wise or of update flag constants (
FORCE
, KEEP_HISTORY
,
ALWAYS_DELETE_PROJECT_CONTENTS
,
and NEVER_DELETE_PROJECT_CONTENTS
)monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this method fails. Reasons include:
FORCE
is not specified.IFile.delete(boolean, boolean, org.eclipse.core.runtime.IProgressMonitor)
,
IFolder.delete(boolean, boolean, org.eclipse.core.runtime.IProgressMonitor)
,
FORCE
,
KEEP_HISTORY
,
#ALWAYS_DELETE_PROJECT_CONTENTS
,
#NEVER_DELETE_PROJECT_CONTENTS
public void deleteMarkers(String type, boolean includeSubtypes, int depth) throws CoreException
includeSubtypes
is false
, only markers whose type exactly matches
the given type are deleted.
This method changes resources; these changes will be reported in a subsequent resource change event.
type
- the type of marker to consider, or null
to indicate all typesincludeSubtypes
- whether or not to consider subtypes of the given typedepth
- how far to recurse (see IResource.DEPTH_*
)
CoreException
- if this method fails. Reasons include:
DEPTH_ZERO
,
DEPTH_ONE
,
DEPTH_INFINITE
public boolean equals(Object other)
equals
in class Object
other
- the other object
getType()
,
getFullPath()
,
getWorkspace()
public boolean exists()
IResource
objects are lightweight handle objects
used to access resources in the workspace. However, having a
handle object does not necessarily mean the workspace really
has such a resource. When the workspace does have a genuine
resource of a matching type, the resource is said to
exist, and this method returns true
;
in all other cases, this method returns false
.
In particular, it returns false
if the workspace
has no resource at that path, or if it has a resource at that
path with a type different from the type of this resource handle.
Note that no resources ever exist under a project that is closed; opening a project may bring some resources into existence.
The name and path of a resource handle may be invalid. However, validation checks are done automatically as a resource is created; this means that any resource that exists can be safely assumed to have a valid name and path.
true
if the resource exists, otherwise
false
public IMarker findMarker(long id) throws CoreException
null
if there is no matching marker.
id
- the id of the marker to find
null
CoreException
- if this method fails. Reasons include:
public IMarker[] findMarkers(String type, boolean includeSubtypes, int depth) throws CoreException
includeSubtypes
is false
, only markers whose type exactly matches
the given type are returned. Returns an empty array if there
are no matching markers.
type
- the type of marker to consider, or null
to indicate all typesincludeSubtypes
- whether or not to consider subtypes of the given typedepth
- how far to recurse (see IResource.DEPTH_*
)
CoreException
- if this method fails. Reasons include:
DEPTH_ZERO
,
DEPTH_ONE
,
DEPTH_INFINITE
public String getFileExtension()
null
if it does not have one.
The file extension portion is defined as the string following the last period (".") character in the name. If there is no period in the name, the path has no file extension portion. If the name ends in a period, the file extension portion is the empty string.
This is a resource handle operation; the resource need not exist.
getName()
public IPath getFullPath()
This is a resource handle operation; the resource need not exist. If this resource does exist, its path can be safely assumed to be valid.
A resource's full path indicates the route from the root of the workspace
to the resource. Within a workspace, there is exactly one such path
for any given resource. The first segment of these paths name a project;
remaining segments, folders and/or files within that project.
The returned path never has a trailing separator. The path of the
workspace root is Path.ROOT
.
Since absolute paths contain the name of the project, they are vulnerable when the project is renamed. For most situations, project-relative paths are recommended over absolute paths.
getProjectRelativePath()
,
Path.ROOT
public IPath getLocation()
null
if no path can be determined.
If this resource is the workspace root, this method returns the absolute local file system path of the platform working area.
If this resource is a project that exists in the workspace, this method returns the path to the project's local content area. This is true regardless of whether the project is open or closed.
If this resource is a file or folder under a project that exists,
this method returns a (non-null
) path computed from
the location of the project's local content area and the project-relative
path of the file or folder. This is true regardless of whether the
file or folders exists, or whether the project is open or closed.
If this resource is a project that does not exist in the workspace,
or a file or folder below such a project, this method returns
null
.
null
if no path can be determinedIProjectDescription.setLocation(org.eclipse.core.runtime.IPath)
,
Platform.getLocation()
public IMarker getMarker(long id)
id
- the id of the marker
IMarker.getId()
public long getModificationStamp()
NULL_STAMP
if
the resource does not exist or is not local or is not accessible.
A resource's modification stamp gets updated each time a resource is modified. If a resource's modification stamp is the same, the resource has not changed. Conversely, if a resource's modification stamp is different, some aspect of it (other than properties) has been modified at least once (possibly several times). Resource modification stamps are preserved across project close/re-open, and across workspace shutdown/restart. The magnitude or sign of the numerical difference between two modification stamps is not significant.
The following things affect a resource's modification stamp:
NULL_STAMP
)touch
ing a resourceNULL_STAMP
)NULL_STAMP
,
destination changes from NULL_STAMP
)NULL_STAMP
)NULL_STAMP
)NULL_STAMP
)NULL_STAMP
)
NULL_STAMP
if this resource either does
not exist or exists as a closed projectNULL_STAMP
public String getName()
This is a resource handle operation; the resource need not exist.
If this resource exists, its name can be safely assumed to be valid.
getFullPath()
,
getProjectRelativePath()
public IContainer getParent()
null
if it has no parent (that is, this
resource is the workspace root).
The full path of the parent resource is the same as this resource's full path with the last segment removed.
This is a resource handle operation; neither the resource nor the resulting resource need exist.
null
if it has no parentpublic String getPersistentProperty(QualifiedName key) throws CoreException
null
if this resource has no such property.
key
- the qualified name of the property
null
if this resource has no such property
CoreException
- if this method fails. Reasons include:
setPersistentProperty(org.eclipse.core.runtime.QualifiedName, java.lang.String)
public IProject getProject()
null
for the workspace root.
A resource's project is the one named by the first segment of its full path.
This is a resource handle operation; neither the resource nor the resulting project need exist.
public IPath getProjectRelativePath()
This is a resource handle operation; the resource need not exist. If this resource does exist, its path can be safely assumed to be valid.
A resource's project-relative path indicates the route from the project to the resource. Within a workspace, there is exactly one such path for any given resource. The returned path never has a trailing slash.
Project-relative paths are recommended over absolute paths, since the former are no affected if the project is renamed.
getFullPath()
,
getProject()
,
Path.EMPTY
public Object getSessionProperty(QualifiedName key) throws CoreException
null
if this resource has no such property.
key
- the qualified name of the property
null
if this resource has no such property
CoreException
- if this method fails. Reasons include:
setSessionProperty(org.eclipse.core.runtime.QualifiedName, java.lang.Object)
public int getType()
FILE
,
FOLDER
, PROJECT
, ROOT
.
FILE
implement IFile
.FOLDER
implement IFolder
.PROJECT
implement IProject
.ROOT
implement IWorkspaceRoot
.This is a resource handle operation; the resource need not exist in the workspace.
FILE
,
FOLDER
,
PROJECT
,
ROOT
public IWorkspace getWorkspace()
This is a resource handle operation; the resource need not exist in the workspace.
public boolean isAccessible()
true
if this resource is accessible, and
false
otherwiseexists()
,
IProject.isOpen()
public boolean isLocal(int depth)
false
in all other cases,
including the case where this resource does not exist. The workspace
root and projects are always local.
When a resource is not local, its content and properties are unavailable for both reading and writing.
depth
- valid values are DEPTH_ZERO
,
DEPTH_ONE
, or DEPTH_INFINITE
true
if this resource is local, and
false
otherwisesetLocal(boolean, int, org.eclipse.core.runtime.IProgressMonitor)
public boolean isPhantom()
The workspace uses phantom resources to remember outgoing deletions and incoming additions relative to an external synchronization partner. Phantoms appear and disappear automatically as a byproduct of synchronization. Since the workspace root cannot be synchronized in this way, it is never a phantom. Projects are also never phantoms.
The key point is that phantom resources do not exist (in the technical
sense of exists
, which returns false
for phantoms) are therefore invisible except through a handful of
phantom-enabled API methods (notably IContainer.members(boolean)
).
true
if this resource is a phantom resource, and
false
otherwiseexists()
,
IContainer.members(boolean)
,
IContainer.findMember(String, boolean)
,
IContainer.findMember(IPath, boolean)
,
ISynchronizer
public boolean isReadOnly()
true
if this resource is read-only,
false
otherwisepublic boolean isSynchronized(int depth)
A resource is considered to be in sync if all of the following conditions are true:
This operation interrogates files and folders in the local file system; depending on the speed of the local file system and the requested depth, this operation may be time-consuming.
depth
- the depth (one of IResource.DEPTH_ZERO
,
DEPTH_ONE
, or DEPTH_INFINITE
)
true
if this resource and its descendants to the
specified depth are synchronized, and false
in all other
casesDEPTH_ZERO
,
DEPTH_ONE
,
DEPTH_INFINITE
,
refreshLocal(int, org.eclipse.core.runtime.IProgressMonitor)
public void move(IProjectDescription description, boolean force, boolean keepHistory, IProgressMonitor monitor) throws CoreException
This is a convenience method, fully equivalent to:
move(description, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);
This operation changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource has been removed from its parent and that a corresponding resource has been added to its new parent. Additional information provided with resource delta shows that these additions and removals are related.
This method is long-running; progress and cancellation are provided by the given progress monitor.
description
- the destination project descriptionforce
- a flag controlling whether resources that are not
in sync with the local file system will be toleratedkeepHistory
- a flag indicating whether or not to keep
local history for filesmonitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this resource could not be moved. Reasons include:
force
is false
.IResourceDelta.getFlags()
public void move(IPath destination, boolean force, IProgressMonitor monitor) throws CoreException
This is a convenience method, fully equivalent to:
move(destination, force ? FORCE : IResource.NONE, monitor);
This method changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource has been removed from its parent and that a corresponding resource has been added to its new parent. Additional information provided with resource delta shows that these additions and removals are related.
This method is long-running; progress and cancellation are provided by the given progress monitor.
destination
- the destination pathforce
- 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 and cancellation are not desired
CoreException
- if this resource could not be moved. Reasons include:
force
is false
.IResourceDelta.getFlags()
public void move(IProjectDescription description, int updateFlags, IProgressMonitor monitor) throws CoreException
When a resource moves, its session and persistent properties move with it. Likewise for all the other attributes of the resource including markers.
When this project's location is the default location, then the directories and files on disk are moved to be in the location specified by the given description. If the given description specifies the default location for the project, the directories and files are moved to the default location. In all other cases the directories and files on disk are left untouched. If the name in the given description is the same as this project's name and the location is different, then the project contents will be moved to the new location. All other parts of the given description are ignored.
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 move resources that are in sync with the corresponding files and
directories in the local file system; it will fail if it
encounters a resource that is out of sync with the file system.
However, if FORCE
is specified, the method
moves all corresponding files and directories from the local
file system, including ones that have been recently updated or created.
Note that in both settings of the FORCE
flag,
the operation fails if the newly created resources in the
workspace would be out of sync with the local file system;
this ensures files in the file system cannot be accidentally
overwritten.
The KEEP_HISTORY
update flag controls whether or not
file that are about to be deleted from the local file system have their
current contents saved in the workspace's local history. The local history
mechanism serves as a safety net to help the user recover from mistakes that
might otherwise result in data loss. Specifying KEEP_HISTORY
is recommended except in circumstances where past states of the files are of
no conceivable interested to the user. Note that local history is maintained
with each individual project, and gets discarded when a project is deleted
from the workspace. Hence KEEP_HISTORY
is only really applicable
when moving files and folders, but not whole projects.
Update flags other than FORCE
and KEEP_HISTORY
are ignored.
This method changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource has been removed from its parent and that a corresponding resource has been added to its new parent. Additional information provided with resource delta shows that these additions and removals are related.
This method is long-running; progress and cancellation are provided by the given progress monitor.
description
- the destination project descriptionupdateFlags
- bit-wise or of update flag constants
(FORCE
and KEEP_HISTORY
)monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this resource could not be moved. Reasons include:
FORCE
is not specified.IResourceDelta.getFlags()
,
FORCE
,
KEEP_HISTORY
public void move(IPath destination, int updateFlags, IProgressMonitor monitor) throws CoreException
The supplied path may be absolute or relative. Absolute paths fully specify the new location for the resource, including its project. Relative paths are considered to be relative to the container of the resource being moved. A trailing slash is ignored.
Calling this method with a one segment absolute destination path is equivalent to calling:
IProjectDescription description = getDescription(); description.setName(path.lastSegment()); move(description, updateFlags, monitor);
When a resource moves, its session and persistent properties move with it. Likewise for all the other attributes of the resource including markers.
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 move resources that are in sync with the corresponding files and
directories in the local file system; it will fail if it
encounters a resource that is out of sync with the file system.
However, if FORCE
is specified, the method
moves all corresponding files and directories from the local
file system, including ones that have been recently updated or created.
Note that in both settings of the FORCE
flag,
the operation fails if the newly created resources in the
workspace would be out of sync with the local file system;
this ensures files in the file system cannot be accidentally
overwritten.
The KEEP_HISTORY
update flag controls whether or not
file that are about to be deleted from the local file system have their
current contents saved in the workspace's local history. The local history
mechanism serves as a safety net to help the user recover from mistakes that
might otherwise result in data loss. Specifying KEEP_HISTORY
is recommended except in circumstances where past states of the files are of
no conceivable interested to the user. Note that local history is maintained
with each individual project, and gets discarded when a project is deleted
from the workspace. Hence KEEP_HISTORY
is only really applicable
when moving files and folders, but not whole projects.
Update flags other than FORCE
and KEEP_HISTORY
are ignored.
This method changes resources; these changes will be reported in a subsequent resource change event that will include an indication that the resource has been removed from its parent and that a corresponding resource has been added to its new parent. Additional information provided with resource delta shows that these additions and removals are related.
This method is long-running; progress and cancellation are provided by the given progress monitor.
destination
- the destination pathupdateFlags
- bit-wise or of update flag constants
(FORCE
and KEEP_HISTORY
)monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this resource could not be moved. Reasons include:
force
is false
.IResourceDelta.getFlags()
,
FORCE
,
KEEP_HISTORY
public void refreshLocal(int depth, IProgressMonitor monitor) throws CoreException
This method may discover changes to resources; any such changes will be reported in a subsequent resource change event.
If a new file or directory is discovered in the local file system at or below the location of this resource, any parent folders required to contain the new resource in the workspace will also be created automatically as required.
This method is long-running; progress and cancellation are provided by the given progress monitor.
depth
- valid values are DEPTH_ZERO
,
DEPTH_ONE
, or DEPTH_INFINITE
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this method fails. Reasons include:
DEPTH_ZERO
,
DEPTH_ONE
,
DEPTH_INFINITE
public void setLocal(boolean flag, int depth, IProgressMonitor monitor) throws CoreException
false
)
has no affect on the resource.
When a resource is not local, its content and properties are unavailable for both reading and writing.
This method is long-running; progress and cancellation are provided by the given progress monitor.
flag
- whether this resource should be considered localdepth
- valid values are DEPTH_ZERO
,
DEPTH_ONE
, or DEPTH_INFINITE
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this method fails. Reasons include:
isLocal(int)
public void setPersistentProperty(QualifiedName key, String value) throws CoreException
null
,
the persistent property is removed from this resource. The change
is made immediately on disk.
Persistent properties are intended to be used by plug-ins to store resource-specific information that should be persisted across platform sessions. The value of a persistent property is a string which should be short (i.e., under 2KB). Unlike session properties, persistent properties are stored on disk and maintained across workspace shutdown and restart.
The qualifier part of the property name must be the unique identifier
of the declaring plug-in (e.g. "com.example.plugin"
).
key
- the qualified name of the propertyvalue
- the string value of the property,
or null
if the property is to be removed
CoreException
- if this method fails. Reasons include:
getPersistentProperty(org.eclipse.core.runtime.QualifiedName)
,
isLocal(int)
public void setReadOnly(boolean readOnly)
public void setSessionProperty(QualifiedName key, Object value) throws CoreException
null
,
the session property is removed from this resource.
Sessions properties are intended to be used as a caching mechanism by ISV plug-ins. They allow key-object associations to be stored with existing resources in the workspace. These key-value associations are maintained in memory (at all times), and the information is lost when a resource is deleted from the workspace, when the parent project is closed, or when the workspace is closed.
The qualifier part of the property name must be the unique identifier
of the declaring plug-in (e.g. "com.example.plugin"
).
key
- the qualified name of the propertyvalue
- the value of the session property,
or null
if the property is to be removed
CoreException
- if this method fails. Reasons include:
getSessionProperty(org.eclipse.core.runtime.QualifiedName)
public void touch(IProgressMonitor monitor) throws CoreException
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.
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this method fails. Reasons include:
public boolean isDerived()
false
if this resource does not exist.
true
if this resource is marked as derived, and
false
otherwisesetDerived(boolean)
public void setDerived(boolean isDerived) throws CoreException
A derived resource is a regular file or folder that is created in the course of translating, compiling, copying, or otherwise processing other files. Derived resources are not original data, and can be recreated from other resources. It is commonplace to exclude derived resources from version and configuration management because they would otherwise clutter the team repository with version of these ever-changing files as each user regenerates them.
If a resource or any of its ancestors is marked as derived, a team
provider should assume that the resource is not under version and
configuration management
Newly-created resources are not marked as derived; rather, the mark must be
set explicitly using setDerived(true)
. Derived marks are maintained
in the in-memory resource tree, and are discarded when the resources is deleted.
Derived marks are saved to disk when a project is closed, or when the workspace
is saved.
Projects and the workspace root are never considered derived; attempts to mark them as derived are ignored.
This operation does not result in a resource change event, and does not trigger auto-builds.
isDerived
- true
if this resource is to be marked
as derived, and false
otherwise
CoreException
- if this method fails. Reasons include:
isDerived()
public boolean isTeamPrivateMember()
false
if this resource does not exist.
true
if this resource is a team private member, and
false
otherwisesetTeamPrivateMember(boolean)
public void setTeamPrivateMember(boolean isTeamPrivate) throws CoreException
A team private member resource is a special file or folder created by a team provider to hold team-provider-specific information. Resources marked as team private members are invisible to most clients.
Newly-created resources are not team private members by default; rather, the
team provider must mark a resource explicitly using
setTeamPrivateMember(true)
. Team private member marks are maintained
in the in-memory resource tree, and are discarded when the resources is deleted.
Team private member marks are saved to disk when a project is closed, or when the
workspace is saved.
Projects and the workspace root are never considered team private members; attempts to mark them as derived are ignored.
This operation does not result in a resource change event, and does not trigger auto-builds.
isTeamPrivate
- true
if this resource is to be marked
as team private, and false
otherwise
CoreException
- if this method fails. Reasons include:
isTeamPrivateMember()
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |