|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.ide.undo.ResourceDescription
ResourceDescription is a lightweight description that describes the common attributes of a resource to be created. This class is not intended to be extended by clients.
Constructor Summary | |
---|---|
ResourceDescription()
|
Method Summary | |
---|---|
abstract void |
createExistentResourceFromHandle(IResource resource,
IProgressMonitor monitor)
Given a resource handle, create an actual resource with the attributes of the receiver resource description. |
abstract IResource |
createResource(IProgressMonitor monitor)
Create an existent resource from this resource description. |
abstract IResource |
createResourceHandle()
Create a resource handle that can be used to create a resource from this resource description. |
static ResourceDescription |
fromResource(IResource resource)
Create a resource description given the specified resource. |
abstract String |
getName()
Get the name of this resource. |
abstract boolean |
isValid()
Return a boolean indicating whether this resource description has enough information to create a resource. |
abstract void |
recordStateFromHistory(IResource resource,
IProgressMonitor monitor)
Record the appropriate state of this resource description using any available resource history. |
abstract boolean |
verifyExistence(boolean checkMembers)
Return a boolean indicating whether this description represents an existent resource. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ResourceDescription()
Method Detail |
public static ResourceDescription fromResource(IResource resource)
resource
- the resource from which a description should be created
public abstract IResource createResourceHandle()
public abstract String getName()
public abstract IResource createResource(IProgressMonitor monitor) throws CoreException
monitor
- the progress monitor to use
CoreException
public abstract void createExistentResourceFromHandle(IResource resource, IProgressMonitor monitor) throws CoreException
resource
- the resource handlemonitor
- the progress monitor to be used when creating the resource
CoreException
public abstract boolean isValid()
true
if the resource can be created, and
false
if it does not have enough informationpublic abstract void recordStateFromHistory(IResource resource, IProgressMonitor monitor) throws CoreException
resource
- the resource whose state is to be recorded.monitor
- the progress monitor to be used
CoreException
public abstract boolean verifyExistence(boolean checkMembers)
checkMembers
- Use true
if members should also exist in order
for this description to be considered existent. A value of
false
indicates that the existence of members
does not matter.
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.