BackgroundTaskByVfsChangeTask.java example

Explorer
consulo-master
/*
 * Copyright 2013-2016 consulo.io
 *
 * 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 consulo.backgroundTaskByVfsChange;

import com.intellij.openapi.project.Project;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.openapi.vfs.pointers.VirtualFilePointer;
import consulo.util.pointers.Named;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import consulo.annotations.RequiredReadAction;

/**
 * @author VISTALL
 * @since 22:47/06.10.13
 */
public interface BackgroundTaskByVfsChangeTask extends Named {
  boolean isEnabled();

  void setEnabled(boolean enabled);

  @NotNull
  String getProviderName();

  @Nullable
  BackgroundTaskByVfsChangeProvider getProvider();

  @NotNull
  VirtualFilePointer getVirtualFilePointer();

  @NotNull
  BackgroundTaskByVfsParameters getParameters();

  @NotNull
  @RequiredReadAction
  String[] getGeneratedFilePaths();

  @NotNull
  @RequiredReadAction
  VirtualFile[] getGeneratedFiles();

  @NotNull
  Project getProject();

  @NotNull
  BackgroundTaskByVfsChangeTask clone();
}