Package com.intellij.openapi.vfs

Interface LocalFileOperationsHandler

All Known Implementing Classes:

CvsFileOperationsHandler, SvnFileSystemListener

public interface LocalFileOperationsHandler

Allows a version control plugin to intercept file operations performed in the local file system and to perform them through the corresponding VCS.

See Also:

LocalFileSystem.registerAuxiliaryFileOperationsHandler(LocalFileOperationsHandler)

Method Summary

Modifier and Type	Method and Description
void	afterDone(ThrowableConsumer<LocalFileOperationsHandler,java.io.IOException> invoker)
java.io.File	copy(VirtualFile file, VirtualFile toDir, java.lang.String copyName) Intercepts the copying of a file.
boolean	createDirectory(VirtualFile dir, java.lang.String name) Intercepts the creation of a directory.
boolean	createFile(VirtualFile dir, java.lang.String name) Intercepts the creation of a file.
boolean	delete(VirtualFile file) Intercepts the deletion of a file.
boolean	move(VirtualFile file, VirtualFile toDir) Intercepts the movement of a file.
boolean	rename(VirtualFile file, java.lang.String newName) Intercepts the renaming of a file.

Method Detail

delete

boolean delete(VirtualFile file)
        throws java.io.IOException

Intercepts the deletion of a file.

Parameters:

file - the file being deleted.

Returns:

true if the handler has performed the deletion, false if the deletion needs to be performed through standard core logic.

Throws:

java.io.IOException

move

boolean move(VirtualFile file,
             VirtualFile toDir)
      throws java.io.IOException

Intercepts the movement of a file.

Parameters:

file - the file being moved.

toDir - the destination directory.

Returns:

true if the handler has performed the move, false if the move needs to be performed through standard core logic.

Throws:

java.io.IOException

copy

java.io.File copy(VirtualFile file,
                  VirtualFile toDir,
                  java.lang.String copyName)
           throws java.io.IOException

Intercepts the copying of a file.

Parameters:

file - the file being copied.

toDir - the destination directory.

copyName - the name for the copy

Returns:

the copy result if the handler has performed the copy, null if the copy needs to be performed through standard core logic.

Throws:

java.io.IOException

rename

boolean rename(VirtualFile file,
               java.lang.String newName)
        throws java.io.IOException

Intercepts the renaming of a file.

Parameters:

file - the file being renamed.

newName - the new name.

Returns:

true if the handler has performed the rename, false if the rename needs to be performed through standard core logic.

Throws:

java.io.IOException

createFile

boolean createFile(VirtualFile dir,
                   java.lang.String name)
            throws java.io.IOException

Intercepts the creation of a file.

Parameters:

dir - the directory in which the file is being created.

name - the name of the new file.

Returns:

true if the handler has performed the file creation, false if the creation needs to be performed through standard core logic.

Throws:

java.io.IOException

createDirectory

boolean createDirectory(VirtualFile dir,
                        java.lang.String name)
                 throws java.io.IOException

Intercepts the creation of a directory.

Parameters:

dir - the directory in which the directory is being created.

name - the name of the new directory.

Returns:

true if the handler has performed the directory creation, false if the creation needs to be performed through standard core logic.

Throws:

java.io.IOException

afterDone

void afterDone(ThrowableConsumer<LocalFileOperationsHandler,java.io.IOException> invoker)