Package com.atlassian.confluence.util.io

Class ConfluenceFileUtils

java.lang.Object

com.atlassian.confluence.util.io.ConfluenceFileUtils

public class ConfluenceFileUtils
extends Object

Utilities that patch/extend Atlassian Core FileUtils.

TODO: Migrate these out of confluence, into a common module

Constructor Summary

Constructors

Constructor	Description
ConfluenceFileUtils()

Method Summary

Modifier and Type	Method	Description
static String	extractFileName(String pathname)	extractFileName extracts the name of the file
static boolean	isChildOf(File dir, File child)	Determine if a file is a child of another
static void	moveDir(File srcDir, File destDir)	move a directory with all it's children into another directory if destination directory already exists, it will be deleted.
static void	moveDirWithCopyFallback(io.atlassian.fugue.Either<AttachmentRef,AttachmentRef.Container> container, File srcDir, File destDir, DeferredFileDeletionQueue deferredFileDeletionQueue)	Calls moveDir(java.io.File, java.io.File) to move the directory.
static void	moveDirWithCopyFallback(File srcDir, File destDir, DeferredFileDeletionQueue deferredFileDeletionQueue)	Calls moveDir(java.io.File, java.io.File) to move the directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfluenceFileUtils

public ConfluenceFileUtils()

Method Detail

moveDir

public static void moveDir(File srcDir,
                           File destDir)
                    throws IOException

move a directory with all it's children into another directory if destination directory already exists, it will be deleted.

Retries a move once, after a short delay, if the move cannot complete for some reason. e.g. rename c:/foo/bar to c:/fooz/bar

Throws:

IOException

moveDirWithCopyFallback

public static void moveDirWithCopyFallback(io.atlassian.fugue.Either<AttachmentRef,AttachmentRef.Container> container,
                                           File srcDir,
                                           File destDir,
                                           DeferredFileDeletionQueue deferredFileDeletionQueue)
                                    throws IOException

Calls moveDir(java.io.File, java.io.File) to move the directory. If that fails, it falls back to copying the source directory to the destination directory.

Parameters:

container - the information of container

srcDir - the directory to copy

destDir - the location to copy to - it will be created if it does not exist

deferredFileDeletionQueue -

Throws:

IOException - when the move or copy operations fail.

moveDirWithCopyFallback

public static void moveDirWithCopyFallback(File srcDir,
                                           File destDir,
                                           DeferredFileDeletionQueue deferredFileDeletionQueue)
                                    throws IOException

Calls moveDir(java.io.File, java.io.File) to move the directory. If that fails, it falls back to copying the source directory to the destination directory.

Parameters:

srcDir - the directory to copy

destDir - the location to copy to - it will be created if it does not exist

deferredFileDeletionQueue -

Throws:

IOException - when the move or copy operations fail.

isChildOf

public static boolean isChildOf(File dir,
                                File child)

Determine if a file is a child of another

Parameters:

dir - the directory to check

child - the child to find

extractFileName

public static String extractFileName(String pathname)

extractFileName extracts the name of the file

Parameters:

pathname - - file pathname

Returns:

file name, without the path

Since:

7.0.0