Eclipse Platform
2.1

Uses of Interface
org.eclipse.core.runtime.IPath

Packages that use IPath
org.eclipse.core.resources Provides basic support for managing a workspace and its resources. 
org.eclipse.core.resources.team Provides APIs intended to be implemented by the Team component. 
org.eclipse.core.runtime Provides core support for plug-ins and the plug-in registry. 
org.eclipse.debug.core Provides support for launching programs, breakpoint management, expression management, and debug events. 
org.eclipse.team.core Application programming interfaces for defining and working with repository providers. 
org.eclipse.ui.actions Classes for actions and operations used in a workbench window, page, or part in the Eclipse Platform User Interface. 
org.eclipse.ui.dialogs Classes for standard dialogs, wizards, and preference pages in the Eclipse Platform User Interface. 
org.eclipse.ui.editors.text Provides a standard text editor and a file-based document provider. 
org.eclipse.ui.views.navigator Provides the standard Resource Navigator view which presents the tree of resources in the workspace. 
org.eclipse.ui.wizards.datatransfer Provides the standard Import and Export wizards for moving resources into and out of the workspace. 
 

Uses of IPath in org.eclipse.core.resources
 

Methods in org.eclipse.core.resources that return IPath
 IPath[] ISaveContext.getFiles()
          Returns current files mapped with the ISaveContext.map facility or an empty array if there are no mapped files.
 IPath ISaveContext.lookup(IPath file)
          Returns the current location for the given file or null if none.
 IPath IProject.getPluginWorkingLocation(IPluginDescriptor plugin)
          Returns the location in the local file system of the project-specific working data area for use by the given plug-in or null if the project does not exist.
 IPath[] ISavedState.getFiles()
          Returns the files mapped with the ISaveContext.map facility.
 IPath ISavedState.lookup(IPath file)
          Returns the mapped location associated with the given path or null if none.
 IPath IResourceStatus.getPath()
          Returns the path of the resource associated with this status.
 IPath IFile.getFullPath()
          Returns the full path of this file.
 IPath IPathVariableManager.getValue(String name)
          Returns the value of the path variable with the given name.
 IPath IPathVariableManager.resolvePath(IPath path)
          Resolves a relative IPath object potentially containing a variable reference as its first segment, replacing the variable reference (if any) with the variable's value (which is a concrete absolute path).
 IPath IFileState.getFullPath()
          Returns the full path of this file state.
 IPath IResourceProxy.requestFullPath()
          Returns the full workspace path of the resource being visited.
 IPath IPathVariableChangeEvent.getValue()
          Returns the variable's current value.
 IPath IResourceDelta.getFullPath()
          Returns the full, absolute path of this resource delta.
 IPath IResourceDelta.getMovedFromPath()
          Returns the full path (in the "before" state) from which this resource (in the "after" state) was moved.
 IPath IResourceDelta.getMovedToPath()
          Returns the full path (in the "after" state) to which this resource (in the "before" state) was moved.
 IPath IResourceDelta.getProjectRelativePath()
          Returns the project-relative path of this resource delta.
 IPath IResource.getFullPath()
          Returns the full, absolute path of this resource relative to the workspace.
 IPath IResource.getLocation()
          Returns the absolute path in the local file system to this resource, or null if no path can be determined.
 IPath IResource.getProjectRelativePath()
          Returns a relative path of this resource with respect to its project.
 IPath IResource.getRawLocation()
          Returns the file system location of this resource, or null if no path can be determined.
 IPath IStorage.getFullPath()
          Returns the full path of this storage.
 IPath IProjectDescription.getLocation()
          Returns the local file system location for the described project.
 

Methods in org.eclipse.core.resources with parameters of type IPath
 boolean IContainer.exists(IPath path)
          Returns whether a resource of some type with the given path exists relative to this resource.
 IResource IContainer.findMember(IPath path)
          Finds and returns the member resource identified by the given path in this container, or null if no such resource exists.
 IResource IContainer.findMember(IPath path, boolean includePhantoms)
          Finds and returns the member resource identified by the given path in this container, or null if there is no such resource.
 IFile IContainer.getFile(IPath path)
          Returns a handle to the file identified by the given path in this container.
 IFolder IContainer.getFolder(IPath path)
          Returns a handle to the folder identified by the given path in this container.
 IPath ISaveContext.lookup(IPath file)
          Returns the current location for the given file or null if none.
 void ISaveContext.map(IPath file, IPath location)
          Maps the given plug-in file to its real location.
 IPath ISavedState.lookup(IPath file)
          Returns the mapped location associated with the given path or null if none.
 void IFile.createLink(IPath localLocation, int updateFlags, IProgressMonitor monitor)
          Creates a new file resource as a member of this handle's parent resource.
 void IFile.move(IPath destination, boolean force, boolean keepHistory, IProgressMonitor monitor)
          Moves this resource to be at the given location.
 void IPathVariableManager.setValue(String name, IPath value)
          Sets the path variable with the given name to be the specified value.
 IPath IPathVariableManager.resolvePath(IPath path)
          Resolves a relative IPath object potentially containing a variable reference as its first segment, replacing the variable reference (if any) with the variable's value (which is a concrete absolute path).
 IStatus IPathVariableManager.validateValue(IPath path)
          Validates the given path as the value for a path variable.
 IContainer[] IWorkspaceRoot.findContainersForLocation(IPath location)
          Returns the handles to all the resources (workspace root, project, folder) in the workspace which are mapped to the given path in the local file system.
 IFile[] IWorkspaceRoot.findFilesForLocation(IPath location)
          Returns the handles of all files that are mapped to the given path in the local file system.
 IContainer IWorkspaceRoot.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 IWorkspaceRoot.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.
 IResourceDelta IResourceDelta.findMember(IPath path)
          Finds and returns the descendent delta identified by the given path in this delta, or null if no such descendent exists.
 void IResource.copy(IPath destination, boolean force, IProgressMonitor monitor)
          Makes a copy of this resource at the given path.
 void IResource.copy(IPath destination, int updateFlags, IProgressMonitor monitor)
          Makes a copy of this resource at the given path.
 void IResource.move(IPath destination, boolean force, IProgressMonitor monitor)
          Moves this resource so that it is located at the given path.
 void IResource.move(IPath destination, int updateFlags, IProgressMonitor monitor)
          Moves this resource so that it is located at the given path.
 void IFolder.createLink(IPath localLocation, int updateFlags, IProgressMonitor monitor)
          Creates a new folder resource as a member of this handle's parent resource.
 void IFolder.move(IPath destination, boolean force, boolean keepHistory, IProgressMonitor monitor)
          Moves this resource so that it is located at the given path.
 IStatus IWorkspace.copy(IResource[] resources, IPath destination, boolean force, IProgressMonitor monitor)
          Copies the given sibling resources so that they are located as members of the resource at the given path; the names of the copies are the same as the corresponding originals.
 IStatus IWorkspace.copy(IResource[] resources, IPath destination, int updateFlags, IProgressMonitor monitor)
          Copies the given sibling resources so that they are located as members of the resource at the given path; the names of the copies are the same as the corresponding originals.
 IProjectDescription IWorkspace.loadProjectDescription(IPath projectDescriptionFile)
          Reads the project description file (".project") from the given location in the local file system.
 IStatus IWorkspace.move(IResource[] resources, IPath destination, boolean force, IProgressMonitor monitor)
          Moves the given sibling resources so that they are located as members of the resource at the given path; the names of the new members are the same.
 IStatus IWorkspace.move(IResource[] resources, IPath destination, int updateFlags, IProgressMonitor monitor)
          Moves the given sibling resources so that they are located as members of the resource at the given path; the names of the new members are the same.
 IStatus IWorkspace.validateLinkLocation(IResource resource, IPath location)
          Validates the given path as the location of the given resource on disk.
 IStatus IWorkspace.validateProjectLocation(IProject project, IPath location)
          Validates the given path as the location of the given project on disk.
 void IProjectDescription.setLocation(IPath location)
          Sets the local file system location for the described project.
 

Uses of IPath in org.eclipse.core.resources.team
 

Methods in org.eclipse.core.resources.team with parameters of type IPath
 IStatus TeamHook.validateCreateLink(IFile file, int updateFlags, IPath location)
          Validates whether a particular attempt at link creation is allowed.
 IStatus TeamHook.validateCreateLink(IFolder folder, int updateFlags, IPath location)
          Validates whether a particular attempt at link creation is allowed.
 

Uses of IPath in org.eclipse.core.runtime
 

Classes in org.eclipse.core.runtime that implement IPath
 class Path
          The standard implementation of the IPath interface.
 

Methods in org.eclipse.core.runtime that return IPath
 IPath Plugin.getStateLocation()
          Returns the location in the local file system of the plug-in state area for this plug-in.
static IPath Platform.getLocation()
          Returns the location of the platform working directory.
static IPath Platform.getLogFileLocation()
          Returns the location of the platform log file.
static IPath Platform.getPluginStateLocation(Plugin plugin)
          Returns the location in the local file system of the plug-in state area for the given plug-in.
 IPath IPath.addFileExtension(String extension)
          Returns a new path which is the same as this path but with the given file extension added.
 IPath IPath.addTrailingSeparator()
          Returns a path with the same segments as this path but with a trailing separator added.
 IPath IPath.append(String path)
          Returns the canonicalized path obtained from the concatenation of the given string path to the end of this path.
 IPath IPath.append(IPath path)
          Returns the canonicalized path obtained from the concatenation of the given path's segments to the end of this path.
 IPath IPath.makeAbsolute()
          Returns an absolute path with the segments and device id of this path.
 IPath IPath.makeRelative()
          Returns a relative path with the segments and device id of this path.
 IPath IPath.makeUNC(boolean toUNC)
          Return a new path which is the equivalent of this path converted to UNC form (if the given boolean is true) or this path not as a UNC path (if the given boolean is false).
 IPath IPath.removeFileExtension()
          Returns a new path which is the same as this path but with the file extension removed.
 IPath IPath.removeFirstSegments(int count)
          Returns a copy of this path with the given number of segments removed from the beginning.
 IPath IPath.removeLastSegments(int count)
          Returns a copy of this path with the given number of segments removed from the end.
 IPath IPath.removeTrailingSeparator()
          Returns a path with the same segments as this path but with a trailing separator removed.
 IPath IPath.setDevice(String device)
          Returns a new path which is the same as this path but with the given device id.
 IPath IPath.uptoSegment(int count)
          Returns a copy of this path truncated after the given number of segments.
 IPath Path.addFileExtension(String extension)
           
 IPath Path.addTrailingSeparator()
           
 IPath Path.append(String tail)
           
 IPath Path.append(IPath tail)
           
 IPath Path.makeAbsolute()
           
 IPath Path.makeRelative()
           
 IPath Path.makeUNC(boolean toUNC)
           
 IPath Path.removeFileExtension()
           
 IPath Path.removeFirstSegments(int count)
           
 IPath Path.removeLastSegments(int count)
           
 IPath Path.removeTrailingSeparator()
           
 IPath Path.setDevice(String value)
           
 IPath Path.uptoSegment(int count)
           
 IPath ILibrary.getPath()
          Returns the path of this runtime library, relative to the installation location.
 

Methods in org.eclipse.core.runtime with parameters of type IPath
 URL Plugin.find(IPath path)
          Returns a URL for the given path.
 URL Plugin.find(IPath path, Map override)
          Returns a URL for the given path.
 InputStream Plugin.openStream(IPath file)
          Returns an input stream for the specified file.
 InputStream Plugin.openStream(IPath file, boolean localized)
          Returns an input stream for the specified file.
 IPath IPath.append(IPath path)
          Returns the canonicalized path obtained from the concatenation of the given path's segments to the end of this path.
 boolean IPath.isPrefixOf(IPath anotherPath)
          Returns whether this path is a prefix of the given path.
 int IPath.matchingFirstSegments(IPath anotherPath)
          Returns a count of the number of segments which match in this path and the given path (device ids are ignored), comparing in increasing segment number order.
static void Preferences.exportPreferences(IPath file)
          Exports all non-default-valued preferences for all installed plugins to the provided file.
static void Preferences.importPreferences(IPath file)
          Loads the plugin preferences from the given file, and replaces all non-default-valued preferences for all plugins with the values from this file.
static IStatus Preferences.validatePreferenceVersions(IPath file)
          Validates that the preference versions in the given file match the versions of the currently installed plugins.
 IPath Path.append(IPath tail)
           
 boolean Path.isPrefixOf(IPath anotherPath)
           
 int Path.matchingFirstSegments(IPath anotherPath)
           
 URL IPluginDescriptor.find(IPath path)
          Returns a URL for the given path.
 URL IPluginDescriptor.find(IPath path, Map override)
          Returns a URL for the given path.
 

Uses of IPath in org.eclipse.debug.core
 

Methods in org.eclipse.debug.core that return IPath
 IPath ILaunchConfiguration.getLocation()
          Returns the location of this launch configuration as a path.
 

Uses of IPath in org.eclipse.team.core
 

Methods in org.eclipse.team.core with parameters of type IPath
 IStatus RepositoryProvider.validateCreateLink(IResource resource, int updateFlags, IPath location)
          Method validateCreateLink is invoked by the Platform Core TeamHook when a linked resource is about to be added to the provider's project.
 

Uses of IPath in org.eclipse.ui.actions
 

Methods in org.eclipse.ui.actions that return IPath
static IPath CopyResourceAction.getNewNameFor(IPath originalName, IWorkspace workspace)
          Returns a new name for a copy of the resource at the given path in the given workspace.
 

Methods in org.eclipse.ui.actions with parameters of type IPath
protected  IProjectDescription CopyProjectAction.createDescription(IProject project, String projectName, IPath rootLocation)
          Create a new IProjectDescription for the copy using the name and path selected from the dialog.
static IPath CopyResourceAction.getNewNameFor(IPath originalName, IWorkspace workspace)
          Returns a new name for a copy of the resource at the given path in the given workspace.
protected  void RenameResourceAction.runWithNewPath(IPath path, IResource resource)
           
protected  void CopyFilesAndFoldersOperation.copy(IResource[] resources, IPath destination, IProgressMonitor subMonitor)
          Copies the resources to the given destination.
protected  void MoveFilesAndFoldersOperation.copy(IResource[] resources, IPath destination, IProgressMonitor subMonitor)
          Moves the resources to the given destination.
 

Uses of IPath in org.eclipse.ui.dialogs
 

Methods in org.eclipse.ui.dialogs that return IPath
protected  IPath WizardDataTransferPage.getPathFromText(Text textField)
          Get a path from the supplied text widget.
protected  IPath WizardDataTransferPage.queryForContainer(IContainer initialSelection, String msg)
          Queries the user to supply a container resource.
protected  IPath WizardDataTransferPage.queryForContainer(IContainer initialSelection, String msg, String title)
          Queries the user to supply a container resource.
protected  IPath WizardExportPage.getResourcePath()
          Deprecated. Return the path for the resource field.
 IPath SaveAsDialog.getResult()
          Returns the full path entered by the user.
 IPath WizardNewProjectCreationPage.getLocationPath()
          Returns the current project location path as entered by the user, or its anticipated initial value.
protected  IPath WizardImportPage.getContainerFullPath()
          Deprecated. Returns the path of the container resource specified in the container name entry field, or null if no name has been typed in.
protected  IPath WizardImportPage.getResourcePath()
          Deprecated. Return the path for the resource field.
 IPath WizardNewFileCreationPage.getContainerFullPath()
          Returns the current full path of the containing resource as entered or selected by the user, or its anticipated initial value.
protected  IPath WizardResourceImportPage.getContainerFullPath()
          Returns the path of the container resource specified in the container name entry field, or null if no name has been typed in.
protected  IPath WizardResourceImportPage.getResourcePath()
          Return the path for the resource field.
 

Methods in org.eclipse.ui.dialogs with parameters of type IPath
protected  IFile WizardNewFileCreationPage.createFileHandle(IPath filePath)
          Creates a file resource handle for the file with the given workspace path.
 void WizardNewFileCreationPage.setContainerFullPath(IPath path)
          Sets the value of this page's container name field, or stores it for future use if this page's controls do not exist yet.
protected  IFolder WizardNewFolderMainPage.createFolderHandle(IPath folderPath)
          Creates a folder resource handle for the folder with the given workspace path.
protected  boolean WizardResourceImportPage.sourceConflictsWithDestination(IPath sourcePath)
          Returns whether or not the source location conflicts with the destination resource.
 

Constructors in org.eclipse.ui.dialogs with parameters of type IPath
ContainerGenerator(IPath containerPath)
          Creates a generator for the container resource (folder or project) at the given workspace path.
 

Uses of IPath in org.eclipse.ui.editors.text
 

Methods in org.eclipse.ui.editors.text with parameters of type IPath
protected  void FileDocumentProvider.handleElementMoved(IFileEditorInput fileEditorInput, IPath path)
          Sends out the notification that the file serving as document input has been moved.
 

Uses of IPath in org.eclipse.ui.views.navigator
 

Methods in org.eclipse.ui.views.navigator with parameters of type IPath
protected  void ResourceNavigatorRenameAction.runWithNewPath(IPath path, IResource resource)
           
 

Uses of IPath in org.eclipse.ui.wizards.datatransfer
 

Methods in org.eclipse.ui.wizards.datatransfer that return IPath
 IPath WizardExternalProjectImportPage.getLocationPath()
          Returns the current project location path as entered by the user, or its anticipated initial value.
 

Methods in org.eclipse.ui.wizards.datatransfer with parameters of type IPath
protected  void ZipFileStructureProvider.createContainer(IPath pathname)
          Creates a new container zip entry with the specified name, iff it has not already been created.
 

Constructors in org.eclipse.ui.wizards.datatransfer with parameters of type IPath
ImportOperation(IPath containerPath, Object source, IImportStructureProvider provider, IOverwriteQuery overwriteImplementor)
          Creates a new operation that recursively imports the entire contents of the specified root file system object.
ImportOperation(IPath containerPath, Object source, IImportStructureProvider provider, IOverwriteQuery overwriteImplementor, List filesToImport)
          Creates a new operation that imports specific file system objects.
ImportOperation(IPath containerPath, IImportStructureProvider provider, IOverwriteQuery overwriteImplementor, List filesToImport)
          Creates a new operation that imports specific file system objects.
 


Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.