Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> core >> [ resources overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.core.resources.IFile JAVADOC | Sourc code of org.eclipse.core.resources.IFile SOURCE | Download org.eclipse.core.resources.IFile DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.resources
Interface IFile  view IFile download IFile.java

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IEncodedStorage, IResource, org.eclipse.core.runtime.jobs.ISchedulingRule, IStorage
public interface IFile
extends IResource, IEncodedStorage, org.eclipse.core.runtime.IAdaptable

Files are leaf resources which contain data. The contents of a file resource is stored as a file in the local file system.

Files, like folders, may exist in the workspace but not be local; non-local file resources serve as placeholders for files whose content and properties have not yet been fetched from a repository.

This interface is not intended to be implemented by clients.

Files implement the IAdaptable interface; extensions are managed by the platform's adapter manager.

Field Summary
static int ENCODING_ISO_8859_1
          Deprecated. see getEncoding for details
static int ENCODING_UNKNOWN
          Deprecated. see getEncoding for details
static int ENCODING_US_ASCII
          Deprecated. see getEncoding for details
static int ENCODING_UTF_16
          Deprecated. see getEncoding for details
static int ENCODING_UTF_16BE
          Deprecated. see getEncoding for details
static int ENCODING_UTF_16LE
          Deprecated. see getEncoding for details
static int ENCODING_UTF_8
          Deprecated. see getEncoding for details
 
Fields inherited from interface org.eclipse.core.resources.IResource
ALLOW_MISSING_LOCAL, ALWAYS_DELETE_PROJECT_CONTENT, AVOID_NATURE_CONFIG, DEPTH_INFINITE, DEPTH_ONE, DEPTH_ZERO, FILE, FOLDER, FORCE, KEEP_HISTORY, NEVER_DELETE_PROJECT_CONTENT, NONE, NULL_STAMP, PROJECT, ROOT, SHALLOW
 
Method Summary
 void appendContents(java.io.InputStream source, boolean force, boolean keepHistory, org.eclipse.core.runtime.IProgressMonitor monitor)
          Appends the entire contents of the given stream to this file.
 void appendContents(java.io.InputStream source, int updateFlags, org.eclipse.core.runtime.IProgressMonitor monitor)
          Appends the entire contents of the given stream to this file.
 void create(java.io.InputStream source, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
          Creates a new file resource as a member of this handle's parent resource.
 void create(java.io.InputStream source, int updateFlags, org.eclipse.core.runtime.IProgressMonitor monitor)
          Creates a new file resource as a member of this handle's parent resource.
 void createLink(org.eclipse.core.runtime.IPath localLocation, int updateFlags, org.eclipse.core.runtime.IProgressMonitor monitor)
          Creates a new file resource as a member of this handle's parent resource.
 void delete(boolean force, boolean keepHistory, org.eclipse.core.runtime.IProgressMonitor monitor)
          Deletes this file from the workspace.
 java.lang.String getCharset()
          Returns the name of a charset to be used when decoding the contents of this file into characters.
 java.lang.String getCharset(boolean checkImplicit)
          Returns the name of a charset to be used when decoding the contents of this file into characters.
 org.eclipse.core.runtime.content.IContentDescription getContentDescription()
          Returns a description for this file's current contents.
 java.io.InputStream getContents()
          Returns an open input stream on the contents of this file.
 java.io.InputStream getContents(boolean force)
          This refinement of the corresponding IStorage method returns an open input stream on the contents of this file.
 int getEncoding()
          Deprecated. use IFile#getCharset instead
 org.eclipse.core.runtime.IPath getFullPath()
          Returns the full path of this file.
 IFileState[] getHistory(org.eclipse.core.runtime.IProgressMonitor monitor)
          Returns a list of past states of this file known to this workspace.
 java.lang.String getName()
          Returns the name of this file.
 boolean isReadOnly()
          Returns whether this file is read-only.
 void move(org.eclipse.core.runtime.IPath destination, boolean force, boolean keepHistory, org.eclipse.core.runtime.IProgressMonitor monitor)
          Moves this resource to be at the given location.
 void setCharset(java.lang.String newCharset)
          Deprecated. Replaced by setCharset(String, IProgressMonitor) 55 which is a workspace operation and reports changes in resource deltas.
 void setCharset(java.lang.String newCharset, org.eclipse.core.runtime.IProgressMonitor monitor)
          Sets the charset for this file.
 void setContents(IFileState source, boolean force, boolean keepHistory, org.eclipse.core.runtime.IProgressMonitor monitor)
          Sets the contents of this file to the bytes in the given file state.
 void setContents(IFileState source, int updateFlags, org.eclipse.core.runtime.IProgressMonitor monitor)
          Sets the contents of this file to the bytes in the given file state.
 void setContents(java.io.InputStream source, boolean force, boolean keepHistory, org.eclipse.core.runtime.IProgressMonitor monitor)
          Sets the contents of this file to the bytes in the given input stream.
 void setContents(java.io.InputStream source, int updateFlags, org.eclipse.core.runtime.IProgressMonitor monitor)
          Sets the contents of this file to the bytes in the given input stream.
 
Methods inherited from interface org.eclipse.core.resources.IResource
accept, accept, accept, accept, clearHistory, copy, copy, copy, copy, createMarker, delete, delete, deleteMarkers, equals, exists, findMarker, findMarkers, getFileExtension, getLocalTimeStamp, getLocation, getMarker, getModificationStamp, getParent, getPersistentProperty, getProject, getProjectRelativePath, getRawLocation, getSessionProperty, getType, getWorkspace, isAccessible, isDerived, isLinked, isLocal, isPhantom, isSynchronized, isTeamPrivateMember, move, move, move, move, refreshLocal, setDerived, setLocal, setLocalTimeStamp, setPersistentProperty, setReadOnly, 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
 

Field Detail

ENCODING_UNKNOWN

public static final int ENCODING_UNKNOWN
Deprecated. see getEncoding for details

Character encoding constant (value 0) which identifies files that have an unknown character encoding scheme.

See Also:
getEncoding() 55 , Constant Field Values

ENCODING_US_ASCII

public static final int ENCODING_US_ASCII
Deprecated. see getEncoding for details

Character encoding constant (value 1) which identifies files that are encoded with the US-ASCII character encoding scheme.

See Also:
getEncoding() 55 , Constant Field Values

ENCODING_ISO_8859_1

public static final int ENCODING_ISO_8859_1
Deprecated. see getEncoding for details

Character encoding constant (value 2) which identifies files that are encoded with the ISO-8859-1 character encoding scheme, also known as ISO-LATIN-1.

See Also:
getEncoding() 55 , Constant Field Values

ENCODING_UTF_8

public static final int ENCODING_UTF_8
Deprecated. see getEncoding for details

Character encoding constant (value 3) which identifies files that are encoded with the UTF-8 character encoding scheme.

See Also:
getEncoding() 55 , Constant Field Values

ENCODING_UTF_16BE

public static final int ENCODING_UTF_16BE
Deprecated. see getEncoding for details

Character encoding constant (value 4) which identifies files that are encoded with the UTF-16BE character encoding scheme.

See Also:
getEncoding() 55 , Constant Field Values

ENCODING_UTF_16LE

public static final int ENCODING_UTF_16LE
Deprecated. see getEncoding for details

Character encoding constant (value 5) which identifies files that are encoded with the UTF-16LE character encoding scheme.

See Also:
getEncoding() 55 , Constant Field Values

ENCODING_UTF_16

public static final int ENCODING_UTF_16
Deprecated. see getEncoding for details

Character encoding constant (value 6) which identifies files that are encoded with the UTF-16 character encoding scheme.

See Also:
getEncoding() 55 , Constant Field Values
Method Detail

appendContents

public void appendContents(java.io.InputStream source,
                           boolean force,
                           boolean keepHistory,
                           org.eclipse.core.runtime.IProgressMonitor monitor)
                    throws org.eclipse.core.runtime.CoreException
Appends the entire contents of the given stream to this file.

This is a convenience method, fully equivalent to: 

   appendContents(source, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's content have been changed.

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

appendContents

public void appendContents(java.io.InputStream source,
                           int updateFlags,
                           org.eclipse.core.runtime.IProgressMonitor monitor)
                    throws org.eclipse.core.runtime.CoreException
Appends the entire contents of the given stream to this file. The stream, which must not be null, will get closed whether this method succeeds or fails.

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 overwrite a corresponding file in the local file system provided it is in sync with the workspace. This option ensures there is no unintended data loss; it is the recommended setting. However, if FORCE is specified, an attempt will be made to write a corresponding file in the local file system, overwriting any existing one if need be. In either case, if this method succeeds, the resource will be marked as being local (even if it wasn't before).

If this file is non-local then this method will always fail. The only exception is when FORCE is specified and the file exists in the local file system. In this case the file is made local and the given contents are appended.

The KEEP_HISTORY update flag controls whether or not a copy of current contents of this file should be captured in the workspace's local history (properties are not recorded in the 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 interest to the user. Note that local history is maintained with each individual project, and gets discarded when a project is deleted from the workspace. This flag is ignored if the file was not previously local.

Update flags other than FORCE and KEEP_HISTORY are ignored.

Prior to modifying the contents of this file, the file modification validator (if provided by the VCM plug-in), will be given a chance to perform any last minute preparations. Validation is performed by calling IFileModificationValidator.validateSave on this file. If the validation fails, then this operation will fail.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's content have been changed.

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

Since:
2.0

create

public void create(java.io.InputStream source,
                   boolean force,
                   org.eclipse.core.runtime.IProgressMonitor monitor)
            throws org.eclipse.core.runtime.CoreException
Creates a new file resource as a member of this handle's parent resource.

This is a convenience method, fully equivalent to: 

   create(source, (force ? FORCE : IResource.NONE), monitor);

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that the file has been added to its parent.

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

create

public void create(java.io.InputStream source,
                   int updateFlags,
                   org.eclipse.core.runtime.IProgressMonitor monitor)
            throws org.eclipse.core.runtime.CoreException
Creates a new file resource as a member of this handle's parent resource. The resource's contents are supplied by the data in the given stream. This method closes the stream whether it succeeds or fails. If the stream is null then a file is not created in the local file system and the created file is marked as being non-local.

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 write a file in the local file system if it does not already exist. This option ensures there is no unintended data loss; it is the recommended setting. However, if FORCE is specified, this method will attempt to write a corresponding file in the local file system, overwriting any existing one if need be.

Update flags other than FORCE are ignored.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that the file has been added to its parent.

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

Since:
2.0

createLink

public void createLink(org.eclipse.core.runtime.IPath localLocation,
                       int updateFlags,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                throws org.eclipse.core.runtime.CoreException
Creates a new file resource as a member of this handle's parent resource. The file's contents will be located in the file specified by the given file system path. The given path must be either an absolute file system path, or a relative path whose first segment is the name of a workspace path variable.

The ALLOW_MISSING_LOCAL update flag controls how this method deals with cases where the local file system file to be linked does not exist, or is relative to a workspace path variable that is not defined. If ALLOW_MISSING_LOCAL is specified, the operation will suceed even if the local file is missing, or the path is relative to an undefined variable. If ALLOW_MISSING_LOCAL is not specified, the operation will fail in the case where the local file system file does not exist or the path is relative to an undefined variable.

Update flags other than ALLOW_MISSING_LOCAL are ignored.

This method synchronizes this resource with the local file system at the given location.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that the file has been added to its parent.

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

Since:
2.1

delete

public void delete(boolean force,
                   boolean keepHistory,
                   org.eclipse.core.runtime.IProgressMonitor monitor)
            throws org.eclipse.core.runtime.CoreException
Deletes this file from the workspace.

This is a convenience method, fully equivalent to: 

   delete((keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this folder has been removed from its parent.

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

getCharset

public java.lang.String getCharset()
                            throws org.eclipse.core.runtime.CoreException
Returns the name of a charset to be used when decoding the contents of this file into characters.

This refinement of the corresponding IEncodingStorage method is a convenience method, fully equivalent to: 

   getCharset(true);

Note: 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:
getCharset in interface IEncodedStorage
Since:
3.0

getCharset

public java.lang.String getCharset(boolean checkImplicit)
                            throws org.eclipse.core.runtime.CoreException
Returns the name of a charset to be used when decoding the contents of this file into characters.

If checkImplicit is false, this method will return the charset defined by calling setCharset, provided this file exists, or null otherwise.

If checkImplicit is true, this method uses the following algorithm to determine the charset to be returned:

  1. the charset defined by calling #setCharset, if any, and this file exists, or
  2. the charset automatically discovered based on this file's contents, if one can be determined, or
  3. the default encoding for this file's parent (as defined by IContainer#getDefaultCharset).

Note: 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.

Since:
3.0

getContentDescription

public org.eclipse.core.runtime.content.IContentDescription getContentDescription()
                                                                           throws org.eclipse.core.runtime.CoreException
Returns a description for this file's current contents. Returns null if a description cannot be obtained.

Calling this method produces a similar effect as calling getDescriptionFor(getContents(), getName(), IContentDescription.ALL) on IContentTypeManager, but provides better opportunities for improved performance. Therefore, when manipulating IFiles, clients should call this method instead of IContentTypeManager.getDescriptionFor.

Since:
3.0

getContents

public java.io.InputStream getContents()
                                throws org.eclipse.core.runtime.CoreException
Returns an open input stream on the contents of this file. This refinement of the corresponding IStorage method returns an open input stream on the contents of this file. The client is responsible for closing the stream when finished.

Specified by:
getContents in interface IStorage

getContents

public java.io.InputStream getContents(boolean force)
                                throws org.eclipse.core.runtime.CoreException
This refinement of the corresponding IStorage method returns an open input stream on the contents of this file. The client is responsible for closing the stream when finished. If force is true the file is opened and an input stream returned regardless of the sync state of the file. The file is not synchronized with the workspace. If force is false the method fails if not in sync.

getEncoding

public int getEncoding()
                throws org.eclipse.core.runtime.CoreException
Deprecated. use IFile#getCharset instead

Returns a constant identifying the character encoding of this file, or ENCODING_UNKNOWN if it could not be determined. The returned constant will be one of the ENCODING_* constants defined on IFile. This method attempts to guess the file's character encoding by analyzing the first few bytes of the file. If no identifying pattern is found at the beginning of the file, ENC_UNKNOWN will be returned. This method will not attempt any complex analysis of the file to make a guess at the encoding that is used.

getFullPath

public org.eclipse.core.runtime.IPath getFullPath()
Returns the full path of this file. This refinement of the corresponding IStorage and IResource methods links the semantics of resource and storage object paths such that IFiles always have a path and that path is relative to the containing workspace.

Specified by:
getFullPath in interface IResource

getHistory

public IFileState[] getHistory(org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException
Returns a list of past states of this file known to this workspace. Recently added states first.

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

getName

public java.lang.String getName()
Returns the name of this file. This refinement of the corresponding IStorage and IResource methods links the semantics of resource and storage object names such that IFiles always have a name and that name equivalent to the last segment of its full path.

Specified by:
getName in interface IResource

isReadOnly

public boolean isReadOnly()
Returns whether this file is read-only. This refinement of the corresponding IStorage and IResource methods links the semantics of read-only resources and read-only storage objects.

Specified by:
isReadOnly in interface IResource

move

public void move(org.eclipse.core.runtime.IPath destination,
                 boolean force,
                 boolean keepHistory,
                 org.eclipse.core.runtime.IProgressMonitor monitor)
          throws org.eclipse.core.runtime.CoreException
Moves this resource to be at the given location.

This is a convenience method, fully equivalent to: 

   move(destination, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file has been removed from its parent and a new file has been added to the parent of the destination.

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

setCharset

public void setCharset(java.lang.String newCharset)
                throws org.eclipse.core.runtime.CoreException
Deprecated. Replaced by setCharset(String, IProgressMonitor) 55 which is a workspace operation and reports changes in resource deltas.

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

Since:
3.0

setCharset

public void setCharset(java.lang.String newCharset,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                throws org.eclipse.core.runtime.CoreException
Sets the charset for this file. Passing a value of null will remove the charset setting for this resource.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's encoding has changed.

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

Since:
3.0

setContents

public void setContents(java.io.InputStream source,
                        boolean force,
                        boolean keepHistory,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException
Sets the contents of this file to the bytes in the given input stream.

This is a convenience method, fully equivalent to: 

   setContents(source, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's contents have been changed.

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

setContents

public void setContents(IFileState source,
                        boolean force,
                        boolean keepHistory,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException
Sets the contents of this file to the bytes in the given file state.

This is a convenience method, fully equivalent to: 

   setContents(source, (keepHistory ? KEEP_HISTORY : IResource.NONE) | (force ? FORCE : IResource.NONE), monitor);

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's content have been changed.

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

setContents

public void setContents(java.io.InputStream source,
                        int updateFlags,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException
Sets the contents of this file to the bytes in the given input stream. The stream will get closed whether this method succeeds or fails. If the stream is null then the content is set to be the empty sequence of bytes.

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 overwrite a corresponding file in the local file system provided it is in sync with the workspace. This option ensures there is no unintended data loss; it is the recommended setting. However, if FORCE is specified, an attempt will be made to write a corresponding file in the local file system, overwriting any existing one if need be. In either case, if this method succeeds, the resource will be marked as being local (even if it wasn't before).

The KEEP_HISTORY update flag controls whether or not a copy of current contents of this file should be captured in the workspace's local history (properties are not recorded in the 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 interest to the user. Note that local history is maintained with each individual project, and gets discarded when a project is deleted from the workspace. This flag is ignored if the file was not previously local.

Update flags other than FORCE and KEEP_HISTORY are ignored.

Prior to modifying the contents of this file, the file modification validator (if provided by the VCM plug-in), will be given a chance to perform any last minute preparations. Validation is performed by calling IFileModificationValidator.validateSave on this file. If the validation fails, then this operation will fail.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's content have been changed.

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

Since:
2.0

setContents

public void setContents(IFileState source,
                        int updateFlags,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException
Sets the contents of this file to the bytes in the given file state.

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 overwrite a corresponding file in the local file system provided it is in sync with the workspace. This option ensures there is no unintended data loss; it is the recommended setting. However, if FORCE is specified, an attempt will be made to write a corresponding file in the local file system, overwriting any existing one if need be. In either case, if this method succeeds, the resource will be marked as being local (even if it wasn't before).

The KEEP_HISTORY update flag controls whether or not a copy of current contents of this file should be captured in the workspace's local history (properties are not recorded in the 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 interest to the user. Note that local history is maintained with each individual project, and gets discarded when a project is deleted from the workspace. This flag is ignored if the file was not previously local.

Update flags other than FORCE and KEEP_HISTORY are ignored.

Prior to modifying the contents of this file, the file modification validator (if provided by the VCM plug-in), will be given a chance to perform any last minute preparations. Validation is performed by calling IFileModificationValidator.validateSave on this file. If the validation fails, then this operation will fail.

This method changes resources; these changes will be reported in a subsequent resource change event, including an indication that this file's content have been changed.

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

Since:
2.0
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> core >> [ resources overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.core.resources.IFile JAVADOC | Sourc code of org.eclipse.core.resources.IFile SOURCE | Download org.eclipse.core.resources.IFile DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD