org.eclipse.core.internal.resources
Class Container

java.lang.Object
  org.eclipse.core.runtime.PlatformObject
      org.eclipse.core.internal.resources.Resource
          org.eclipse.core.internal.resources.Container

All Implemented Interfaces:

java.lang.Cloneable, ICoreConstants, IPathRequestor, IContainer, IResource, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.jobs.ISchedulingRule

Direct Known Subclasses:

Folder, Project, WorkspaceRoot

public abstract class Container
extends Resource
implements IContainer

Field Summary

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

EXCLUDE_DERIVED, INCLUDE_HIDDEN, INCLUDE_PHANTOMS, INCLUDE_TEAM_PRIVATE_MEMBERS

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

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

Fields inherited from interface org.eclipse.core.internal.resources.ICoreConstants

CRASH_DETECTED, EMPTY_FILE_STATES, EMPTY_PROJECT_ARRAY, EMPTY_RESOURCE_ARRAY, I_NULL_SYNC_INFO, K_BUILD_LIST, M_CHILDREN_UNKNOWN, M_CONTENT_CACHE, M_DEFAULT_CONTENT_DESCRIPTION, M_DERIVED, M_HIDDEN, M_LINK, M_LOCAL_EXISTS, M_MARKERS_SNAP_DIRTY, M_NO_CONTENT_DESCRIPTION, M_OPEN, M_PHANTOM, M_SYNCINFO_SNAP_DIRTY, M_TEAM_PRIVATE_MEMBER, M_TYPE, M_TYPE_START, M_USED, MINIMUM_FILE_SEGMENT_LENGTH, MINIMUM_FOLDER_SEGMENT_LENGTH, NULL_FLAG, PREF_VERSION, PREF_VERSION_KEY, PROJECT_SEGMENT_LENGTH, REFRESH_ON_STARTUP, WORKSPACE_TREE_VERSION_1, WORKSPACE_TREE_VERSION_2

Method Summary

void	convertToPhantom() Converts this resource and all its children into phantoms by modifying their resource infos in-place.
boolean	exists(org.eclipse.core.runtime.IPath childPath) Returns whether a resource of some type with the given path exists relative to this resource.
IFile[]	findDeletedMembersWithHistory(int depth, org.eclipse.core.runtime.IProgressMonitor monitor) Returns a list of recently deleted files inside this container that have one or more saved states in the local history.
IResource	findMember(org.eclipse.core.runtime.IPath childPath) Finds and returns the member resource identified by the given path in this container, or null if no such resource exists.
IResource	findMember(org.eclipse.core.runtime.IPath childPath, boolean phantom) Finds and returns the member resource identified by the given path in this container, or null if there is no such resource.
IResource	findMember(java.lang.String name) Finds and returns the member resource (project, folder, or file) with the given name in this container, or null if no such resource exists.
IResource	findMember(java.lang.String name, boolean phantom) Finds and returns the member resource (project, folder, or file) with the given name in this container, or null if there is no such resource.
java.lang.String	getDefaultCharset() Returns the default charset for resources in this container.
IFile	getFile(org.eclipse.core.runtime.IPath childPath) Returns a handle to the file identified by the given path in this container.
IFile	getFile(java.lang.String name)
IFolder	getFolder(org.eclipse.core.runtime.IPath childPath) Returns a handle to the folder identified by the given path in this container.
IFolder	getFolder(java.lang.String name)
boolean	isLocal(int flags, int depth) Deprecated.
IResource[]	members() Returns a list of existing member resources (projects, folders and files) in this resource, in no particular order.
IResource[]	members(boolean phantom) Returns a list of all member resources (projects, folders and files) in this resource, in no particular order.
IResource[]	members(int memberFlags) Returns a list of all member resources (projects, folders and files) in this resource, in no particular order.
void	setDefaultCharset(java.lang.String charset) Deprecated. Replaced by setDefaultCharset(String, IProgressMonitor) which is a workspace operation and reports changes in resource deltas.
void	setDefaultCharset(java.lang.String newCharset, org.eclipse.core.runtime.IProgressMonitor monitor) Sets the default charset for this container.

Methods inherited from class org.eclipse.core.internal.resources.Resource

accept, accept, accept, accept, checkAccessible, checkCopyRequirements, checkDoesNotExist, checkExists, checkLocal, checkValidPath, clearHistory, contains, copy, copy, copy, copy, countResources, createLink, createLink, createMarker, createProxy, delete, delete, delete, deleteMarkers, deleteResource, equals, exists, exists, findExistingResourceVariant, findMarker, findMarkers, findMaxProblemSeverity, getFileExtension, getFlags, getFullPath, getLocalManager, getLocalTimeStamp, getLocation, getLocationURI, getMarker, getModificationStamp, getName, getParent, getPersistentProperties, getPersistentProperty, getProject, getProjectRelativePath, getPropertyManager, getRawLocation, getRawLocationURI, getResourceAttributes, getResourceInfo, getSessionProperties, getSessionProperty, getStore, getType, getTypeString, getWorkspace, hashCode, isAccessible, isConflicting, isDerived, isDerived, isHidden, isHidden, isLinked, isLinked, isLocal, isPhantom, isPhantom, isReadOnly, isSynchronized, isTeamPrivateMember, isTeamPrivateMember, isUnderLink, move, move, move, move, move, refreshLocal, requestName, requestPath, revertModificationStamp, setDerived, setHidden, setLocal, setLocalTimeStamp, setPersistentProperty, setReadOnly, setResourceAttributes, setSessionProperty, setTeamPrivateMember, synchronizing, toString, touch

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getDefaultCharset

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

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, getPersistentProperties, getPersistentProperty, getProject, getProjectRelativePath, getRawLocation, getRawLocationURI, getResourceAttributes, getSessionProperties, getSessionProperty, getType, getWorkspace, isAccessible, isDerived, isDerived, isHidden, isHidden, isLinked, isLinked, isLocal, isPhantom, isReadOnly, isSynchronized, isTeamPrivateMember, isTeamPrivateMember, move, move, move, move, refreshLocal, revertModificationStamp, setDerived, setHidden, setLocal, setLocalTimeStamp, setPersistentProperty, setReadOnly, setResourceAttributes, setSessionProperty, setTeamPrivateMember, touch

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

getAdapter

Methods inherited from interface org.eclipse.core.runtime.jobs.ISchedulingRule

contains, isConflicting

Method Detail

convertToPhantom

public void convertToPhantom()
                      throws org.eclipse.core.runtime.CoreException

Converts this resource and all its children into phantoms by modifying their resource infos in-place.

Overrides:

convertToPhantom in class Resource

Throws:

org.eclipse.core.runtime.CoreException

exists

public boolean exists(org.eclipse.core.runtime.IPath childPath)

Description copied from interface: IContainer

Returns whether a resource of some type with the given path exists relative to this resource. The supplied path may be absolute or relative; in either case, it is interpreted as relative to this resource. Trailing separators are ignored. If the path is empty this container is checked for existence.

Specified by:

exists in interface IContainer

Parameters:

childPath - the path of the resource

Returns:

true if a resource of some type with the given path exists relative to this resource, and false otherwise

See Also:

IResource.exists()

findMember

public IResource findMember(java.lang.String name)

Description copied from interface: IContainer

Finds and returns the member resource (project, folder, or file) with the given name in this container, or null if no such resource exists.

N.B. Unlike the methods which traffic strictly in resource handles, this method infers the resulting resource's type from the resource existing at the calculated path in the workspace.

Specified by:

findMember in interface IContainer

Parameters:

name - the string name of the member resource

Returns:

the member resource, or null if no such resource exists

findMember

public IResource findMember(java.lang.String name,
                            boolean phantom)

Description copied from interface: IContainer

Finds and returns the member resource (project, folder, or file) with the given name in this container, or null if there is no such resource.

If the includePhantoms argument is false, only a member resource with the given name that exists will be returned. If the includePhantoms argument is true, the method also returns a resource if the workspace is keeping track of a phantom with that name.

Note that no attempt is made to exclude team-private member resources as with members.

N.B. Unlike the methods which traffic strictly in resource handles, this method infers the resulting resource's type from the existing resource (or phantom) in the workspace.

Specified by:

findMember in interface IContainer

Parameters:

name - the string name of the member resource

phantom - true if phantom resources are of interest; false if phantom resources are not of interest

Returns:

the member resource, or null if no such resource exists

See Also:

IContainer.members(), IResource.isPhantom()

findMember

public IResource findMember(org.eclipse.core.runtime.IPath childPath)

Description copied from interface: IContainer

Finds and returns the member resource identified by the given path in this container, or null if no such resource exists. The supplied path may be absolute or relative; in either case, it is interpreted as relative to this resource. Trailing separators and the path's device are ignored. If the path is empty this container is returned. Parent references in the supplied path are discarded if they go above the workspace root.

Note that no attempt is made to exclude team-private member resources as with members.

N.B. Unlike the methods which traffic strictly in resource handles, this method infers the resulting resource's type from the resource existing at the calculated path in the workspace.

Specified by:

findMember in interface IContainer

Parameters:

childPath - the path of the desired resource

Returns:

the member resource, or null if no such resource exists

findMember

public IResource findMember(org.eclipse.core.runtime.IPath childPath,
                            boolean phantom)

Description copied from interface: IContainer

Finds and returns the member resource identified by the given path in this container, or null if there is no such resource. The supplied path may be absolute or relative; in either case, it is interpreted as relative to this resource. Trailing separators and the path's device are ignored. If the path is empty this container is returned. Parent references in the supplied path are discarded if they go above the workspace root.

If the includePhantoms argument is false, only a resource that exists at the given path will be returned. If the includePhantoms argument is true, the method also returns a resource if the workspace is keeping track of a phantom member resource at the given path.

Note that no attempt is made to exclude team-private member resources as with members.

N.B. Unlike the methods which traffic strictly in resource handles, this method infers the resulting resource's type from the existing resource (or phantom) at the calculated path in the workspace.

Specified by:

findMember in interface IContainer

Parameters:

childPath - the path of the desired resource

phantom - true if phantom resources are of interest; false if phantom resources are not of interest

Returns:

the member resource, or null if no such resource exists

See Also:

IContainer.members(boolean), IResource.isPhantom()

getFile

public IFile getFile(java.lang.String name)

getFile

public IFile getFile(org.eclipse.core.runtime.IPath childPath)

Description copied from interface: IContainer

Returns a handle to the file identified by the given path in this container.

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.

The supplied path may be absolute or relative; in either case, it is interpreted as relative to this resource and is appended to this container's full path to form the full path of the resultant resource. A trailing separator is ignored. The path of the resulting resource must have at least two segments.

Specified by:

getFile in interface IContainer

Parameters:

childPath - the path of the member file

Returns:

the (handle of the) member file

See Also:

IContainer.getFolder(IPath)

getFolder

public IFolder getFolder(java.lang.String name)

getFolder

public IFolder getFolder(org.eclipse.core.runtime.IPath childPath)

Description copied from interface: IContainer

Returns a handle to the folder identified by the given path in this container.

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.

The supplied path may be absolute or relative; in either case, it is interpreted as relative to this resource and is appended to this container's full path to form the full path of the resultant resource. A trailing separator is ignored. The path of the resulting resource must have at least two segments.

Specified by:

getFolder in interface IContainer

Parameters:

childPath - the path of the member folder

Returns:

the (handle of the) member folder

See Also:

IContainer.getFile(IPath)

isLocal

public boolean isLocal(int flags,
                       int depth)

Deprecated.

Description copied from class: Resource

Note the depth parameter is intentionally ignored because this method is over-ridden by Container.isLocal().

Overrides:

isLocal in class Resource

members

public IResource[] members()
                    throws org.eclipse.core.runtime.CoreException

Description copied from interface: IContainer

Returns a list of existing member resources (projects, folders and files) in this resource, in no particular order.

This is a convenience method, fully equivalent to members(IResource.NONE). Team-private member resources are not included in the result.

Note that the members of a project or folder are the files and folders immediately contained within it. The members of the workspace root are the projects in the workspace.

Specified by:

members in interface IContainer

Returns:

an array of members of this resource

Throws:

org.eclipse.core.runtime.CoreException - if this request fails. Reasons include:

• This resource does not exist.
• This resource is a project that is not open.

See Also:

IContainer.findMember(IPath), IResource.isAccessible()

members

public IResource[] members(boolean phantom)
                    throws org.eclipse.core.runtime.CoreException

Description copied from interface: IContainer

Returns a list of all member resources (projects, folders and files) in this resource, in no particular order.

This is a convenience method, fully equivalent to:

   members(includePhantoms ? INCLUDE_PHANTOMS : IResource.NONE);
 

Team-private member resources are not included in the result.

Specified by:

members in interface IContainer

Parameters:

phantom - true if phantom resources are of interest; false if phantom resources are not of interest

Returns:

an array of members of this resource

Throws:

org.eclipse.core.runtime.CoreException - if this request fails. Reasons include:

• This resource does not exist.
• includePhantoms is false and this resource does not exist.
• includePhantoms is false and this resource is a project that is not open.

See Also:

IContainer.members(int), IResource.exists(), IResource.isPhantom()

members

public IResource[] members(int memberFlags)
                    throws org.eclipse.core.runtime.CoreException

Description copied from interface: IContainer

Returns a list of all member resources (projects, folders and files) in this resource, in no particular order.

If the INCLUDE_PHANTOMS flag is not specified in the member flags (recommended), only member resources that exist will be returned. If the INCLUDE_PHANTOMS flag is specified, the result will also include any phantom member resources the workspace is keeping track of.

If the INCLUDE_TEAM_PRIVATE_MEMBERS flag is specified in the member flags, team private members will be included along with the others. If the 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.

If the EXCLUDE_DERIVED flag is not specified, derived resources are included. If the EXCLUDE_DERIVED flag is specified in the member flags, derived resources are not included.

Specified by:

members in interface IContainer

Parameters:

memberFlags - bit-wise or of member flag constants (IContainer.INCLUDE_PHANTOMS, IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS, IContainer.INCLUDE_HIDDEN and IContainer.EXCLUDE_DERIVED) indicating which members are of interest

Returns:

an array of members of this resource

Throws:

org.eclipse.core.runtime.CoreException - if this request fails. Reasons include:

• This resource does not exist.
• the INCLUDE_PHANTOMS flag is not specified and this resource does not exist.
• the INCLUDE_PHANTOMS flag is not specified and this resource is a project that is not open.

See Also:

IResource.exists()

getDefaultCharset

public java.lang.String getDefaultCharset()
                                   throws org.eclipse.core.runtime.CoreException

Description copied from interface: IContainer

Returns the default charset for resources in this container.

This is a convenience method, fully equivalent to:

   getDefaultCharset(true);
 

Note that this method does not check whether the result is a supported charset name. Callers should be prepared to handle UnsupportedEncodingException where this charset is used.

Specified by:

getDefaultCharset in interface IContainer

Returns:

the name of the default charset encoding for this container

Throws:

org.eclipse.core.runtime.CoreException - if this method fails

See Also:

IContainer.getDefaultCharset(boolean), IFile.getCharset()

findDeletedMembersWithHistory

public IFile[] findDeletedMembersWithHistory(int depth,
                                             org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IContainer

Returns a list of recently deleted files inside this container that have one or more saved states in the local history. The depth parameter determines how deep inside the container to look. This resource may or may not exist in the workspace.

When applied to an existing project resource, this method returns recently deleted files with saved states in that project. Note that local history is maintained with each individual project, and gets discarded when a project is deleted from the workspace. If applied to a deleted project, this method returns the empty list.

When applied to the workspace root resource (depth infinity), this method returns all recently deleted files with saved states in all existing projects.

When applied to a folder (or project) resource (depth one), this method returns all recently deleted member files with saved states.

When applied to a folder resource (depth zero), this method returns an empty list unless there was a recently deleted file with saved states at the same path as the folder.

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

Specified by:

findDeletedMembersWithHistory in interface IContainer

Parameters:

depth - depth limit: one of DEPTH_ZERO, DEPTH_ONE or DEPTH_INFINITE

monitor - a progress monitor, or null if progress reporting and cancellation are not desired

Returns:

an array of recently deleted files

See Also:

IFile.getHistory(IProgressMonitor)

setDefaultCharset

public void setDefaultCharset(java.lang.String charset)
                       throws org.eclipse.core.runtime.CoreException

Deprecated. Replaced by setDefaultCharset(String, IProgressMonitor) which is a workspace operation and reports changes in resource deltas.

(non-Javadoc)

Specified by:

setDefaultCharset in interface IContainer

Parameters:

charset - a charset string, or null

Throws:

org.eclipse.core.runtime.CoreException - if this method fails Reasons include:

• This resource does not exist.
• An error happened while persisting this setting.

See Also:

IContainer.setDefaultCharset(String)

setDefaultCharset

public void setDefaultCharset(java.lang.String newCharset,
                              org.eclipse.core.runtime.IProgressMonitor monitor)
                       throws org.eclipse.core.runtime.CoreException

Description copied from interface: IContainer

Sets the default charset for this container. Passing a value of null will remove the default charset setting for this resource.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that the encoding of affected resources has been changed.

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

Specified by:

setDefaultCharset in interface IContainer

Parameters:

newCharset - a charset string, or null

monitor - a progress monitor, or null if progress reporting is not desired

Throws:

org.eclipse.core.runtime.CoreException - if this method fails Reasons include:

• This resource is not accessible.
• An error happened while persisting this setting.
• Resource changes are disallowed during certain types of resource change event notification. See IResourceChangeEvent for more details.

See Also:

IContainer.getDefaultCharset(), IResourceRuleFactory.charsetRule(IResource)