|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A previous state of a file stored in the workspace's local history.
Certain methods for updating, deleting, or moving a file cause the "before" contents of the file to be copied to an internal area of the workspace called the local history area thus providing a limited history of earlier states of a file.
This history is based on paths only. Thus, for example, moving a file does not move its history. The history, if any, remains related to the original path. Deleting a file and creating another one at the same path also does not affect the history. If the original file had history, that same history will be available for the new one.
The local history does not track resource properties. File states are volatile; the platform does not guarantee that a certain state will always be in the local history.
This interface is not intended to be implemented by clients.
File state objects implement the IAdaptable
interface;
extensions are managed by the platform's adapter manager.
IFile
,
IStorage
,
Platform.getAdapterManager()
Method Summary | |
boolean |
exists()
Returns whether this file state still exists in the local history. |
InputStream |
getContents()
Returns an open input stream on the contents of this file state. |
IPath |
getFullPath()
Returns the full path of this file state. |
long |
getModificationTime()
Returns the modification time of the file. |
String |
getName()
Returns the name of this file state. |
boolean |
isReadOnly()
Returns whether this file state is read-only. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Method Detail |
public boolean exists()
true
if this state exists, and false
if it does notpublic InputStream getContents() throws CoreException
IStorage
method returns an open input stream
on the contents this file state represents.
The client is responsible for closing the stream when finished.
getContents
in interface IStorage
CoreException
- if this method fails. Reasons include:
public IPath getFullPath()
IStorage
method specifies that IFileState
s always have a
path and that path is the full workspace path of the file represented by this state.
getFullPath
in interface IStorage
null
if none.IResource.getFullPath()
,
IStorage.getFullPath()
public long getModificationTime()
Note that is used only to give the user a general idea of how old this file state is.
public String getName()
IStorage
method specifies that IFileState
s always have a
name and that name is equivalent to the last segment of the full path
of the resource represented by this state.
getName
in interface IStorage
null
if this storage has no nameIResource.getName()
,
IStorage.getName()
public boolean isReadOnly()
IStorage
method restricts IFileState
s
always be read-only.
isReadOnly
in interface IStorage
true
if this storage is read-onlyIStorage
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |