Examples of org.eclipse.core.filesystem.IFileStore.toLocalFile()

org.eclipse.core.filesystem.IFileStore.toLocalFile()

Returns a file in the local file system with the same state as this file.

The {@link EFS#CACHE} option flag indicates whether this methodshould return the actual underlying file or a cached local copy. When the {@link EFS#CACHE} flag is specified, this method will return a cached local file with the same state and contents as this file. When the {@link EFS#CACHE} flag is not specified, this method will returnthe actual underlying local file, or null if this store is not a local file.

In the case of a cached file, the returned file is intended to be used for read operations only. No guarantee is made about synchronization between the returned file and this store. If the cached file is modified in any way, those changes may not be reflected in this store, but may affect other callers who are using the local representation of this store.

While the implementation of this method may use caching to return the same result for multiple calls to this method, it is guaranteed that the returned file will reflect the state of this file store at the time of this call. As such, this method will always contact the backing file system of this store, either to validate cache consistency or to fetch new contents.

The caller is not responsible for deleting this file when they are done with using it. If the returned file is a cached copy, it will be deleted automatically at the end of this session (Eclipse shutdown or virtual machine exit).

@param options bit-wise or of option flag constants (only {@link EFS#CACHE} applies). @param monitor a progress monitor, or null if progressreporting and cancellation are not desired @return A local file with the same state as this file or nullif {@link EFS#CACHE} is not specified and this is not a local file. @exception CoreException if this method fails. Reasons include:

A corresponding file could not be created in the local file system.

@see IFileSystem#fromLocalFile(java.io.File)

          IFileStore store = EFS.getStore(locationURI);
      //first try to obtain a local file directly fo1r this store
      java.io.File localFile = store.toLocalFile(EFS.NONE, null);
      //if no local file is available, obtain a cached file
      if (localFile == null)
        localFile = store.toLocalFile(EFS.CACHE, null);
      if (localFile == null)
        return false;
      return true;
    } catch (CoreException e) {
      //this can only happen if the file system is not available for this scheme

          final URI locationURI = file.getLocationURI();
          if (locationURI == null)
             throw new IllegalArgumentException();
          IFileStore store = EFS.getStore(locationURI);
      //first try to obtain a local file directly fo1r this store
      java.io.File localFile = store.toLocalFile(EFS.NONE, null);
      //if no local file is available, obtain a cached file
      if (localFile == null)
        localFile = store.toLocalFile(EFS.CACHE, null);
      if (localFile == null)
        throw new IllegalArgumentException();

          IFileStore store = EFS.getStore(locationURI);
      //first try to obtain a local file directly fo1r this store
      java.io.File localFile = store.toLocalFile(EFS.NONE, null);
      //if no local file is available, obtain a cached file
      if (localFile == null)
        localFile = store.toLocalFile(EFS.CACHE, null);
      if (localFile == null)
        throw new IllegalArgumentException();
      return Path.fromOSString(localFile.getAbsolutePath());
    } catch (CoreException e) {
      //this can only happen if the file system is not available for this scheme

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.