platform/platform-api/src/com/intellij/openapi/vfs/LocalFileSystem.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.openapi.vfs;
  17
  18 import com.intellij.openapi.application.ApplicationManager;
  19 import com.intellij.openapi.application.CachedSingletonsRegistry;
  20 import com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem;
  21 import com.intellij.util.Processor;
  22 import com.intellij.util.io.fs.IFile;
  23 import org.jetbrains.annotations.NonNls;
  24 import org.jetbrains.annotations.NotNull;
  25 import org.jetbrains.annotations.Nullable;
  26
  27 import java.io.File;
  28 import java.io.IOException;
  29 import java.util.Collection;
  30 import java.util.Set;
  31
  32 public abstract class LocalFileSystem extends NewVirtualFileSystem {
  33   @NonNls public static final String PROTOCOL = "file";
  34   @NonNls public static final String PROTOCOL_PREFIX = PROTOCOL + "://";
  35
  36   private static LocalFileSystem ourInstance = CachedSingletonsRegistry.markCachedField(LocalFileSystem.class);
  37
  38   public static LocalFileSystem getInstance() {
  39     if (ourInstance == null) {
  40       ourInstance = ApplicationManager.getApplication().getComponent(LocalFileSystem.class);
  41     }
  42     return ourInstance;
  43   }
  44
  45   @Nullable
  46   public abstract VirtualFile findFileByIoFile(File file);
  47
  48   @Nullable
  49   public abstract VirtualFile findFileByIoFile(IFile file);
  50
  51   @Nullable
  52   public abstract VirtualFile refreshAndFindFileByIoFile(@NotNull File file);
  53
  54   @Nullable
  55   public abstract VirtualFile refreshAndFindFileByIoFile(final IFile ioFile);
  56
  57   /**
  58    * Performs a nonrecursive synchronous refresh of specified files
  59    * @param files files to refresh
  60    * @since 6.0
  61    */
  62   public abstract void refreshIoFiles(Iterable<File> files);
  63
  64   /**
  65    * Performs a nonrecursive synchronous refresh of specified files
  66    * @param files files to refresh
  67    * @since 6.0
  68    */
  69   public abstract void refreshFiles(Iterable<VirtualFile> files);
  70
  71
  72   public abstract byte[] physicalContentsToByteArray(final VirtualFile virtualFile) throws IOException;
  73   public abstract long physicalLength(final VirtualFile virtualFile) throws IOException;
  74
  75   public interface WatchRequest {
  76     @NotNull String getRootPath();
  77
  78     @NotNull String getFileSystemRootPath();
  79
  80     boolean isToWatchRecursively();
  81
  82     boolean dominates (WatchRequest other);
  83   }
  84
  85   /**
  86    * Adds this rootFile as the watch root for file system
  87    * @param rootPath
  88    * @param toWatchRecursively whether the whole subtree should be monitored
  89    * @return request handle or null if rootFile does not belong to this file system
  90    */
  91   @Nullable
  92   public abstract WatchRequest addRootToWatch(@NotNull final String rootPath, final boolean toWatchRecursively);
  93
  94   @NotNull
  95   public abstract Set<WatchRequest> addRootsToWatch(@NotNull final Collection<String> rootPaths, final boolean toWatchRecursively);
  96
  97   public abstract void removeWatchedRoots(@NotNull final Collection<WatchRequest> rootsToWatch);
  98
  99   public abstract void removeWatchedRoot(@NotNull final WatchRequest watchRequest);
 100
 101   public abstract void registerAuxiliaryFileOperationsHandler(LocalFileOperationsHandler handler);
 102   public abstract void unregisterAuxiliaryFileOperationsHandler(LocalFileOperationsHandler handler);
 103
 104   public abstract boolean processCachedFilesInSubtree(final VirtualFile file, Processor<VirtualFile> processor);
 105 }