FileManager.java example

Explorer
consulo-master
/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.intellij.psi.impl.file.impl;

import com.intellij.openapi.Disposable;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.FileViewProvider;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiFile;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.TestOnly;
import consulo.annotations.RequiredReadAction;
import consulo.annotations.RequiredWriteAction;

import java.util.List;

public interface FileManager extends Disposable {
  @Nullable
  @RequiredReadAction
  PsiFile findFile(@NotNull VirtualFile vFile);

  @Nullable
  @RequiredReadAction
  PsiDirectory findDirectory(@NotNull VirtualFile vFile);

  @RequiredWriteAction
  void reloadFromDisk(@NotNull PsiFile file); //Q: move to PsiFile(Impl)?

  @Nullable
  @RequiredReadAction
  PsiFile getCachedPsiFile(@NotNull VirtualFile vFile);

  @TestOnly
  void cleanupForNextTest();

  @RequiredReadAction
  FileViewProvider findViewProvider(@NotNull VirtualFile file);

  @RequiredReadAction
  FileViewProvider findCachedViewProvider(@NotNull VirtualFile file);

  @RequiredReadAction
  void setViewProvider(@NotNull VirtualFile virtualFile, FileViewProvider fileViewProvider);

  @NotNull
  List<PsiFile> getAllCachedFiles();

  @NotNull
  FileViewProvider createFileViewProvider(@NotNull VirtualFile file, boolean physical);
}