com.facebook.buck.util.unarchive

Class DirectoryCreator

java.lang.Object

com.facebook.buck.util.unarchive.DirectoryCreator

public class DirectoryCreator
extends Object

Simple class that creates directories, but keeps track of what it has created to ensure that it does not create directories more than once. This is useful when extracting archives that may or may not have duplicate entries, or to just ensure that a directory always exists before writing out a new file

Constructor Summary

Constructors

Constructor and Description
DirectoryCreator(ProjectFilesystem filesystem) Creates an instance of DirectoryCreator

Method Summary

Modifier and Type	Method and Description
void	forcefullyCreateDirs(Path target) Force a directory to be created.
ProjectFilesystem	getFilesystem()
void	mkdirs(Path target) Create a directory and all of its parents
Set<Path>	recordedDirectories() Get the set of directories that were either created by this class, or manually specified in recordPath(Path)
void	recordPath(Path target) Ensure that we record that a path was created.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryCreator

public DirectoryCreator(ProjectFilesystem filesystem)

Creates an instance of DirectoryCreator

Parameters:

filesystem - The filesystem to operate on

Method Detail

recordedDirectories

public Set<Path> recordedDirectories()

Get the set of directories that were either created by this class, or manually specified in recordPath(Path)

Returns:

Set of directories

recordPath

public void recordPath(Path target)

Ensure that we record that a path was created. This can be useful if for some reason a directory is created externally, but the list of created directories is pulled from an instance of DirectoryCreator

Parameters:

target -

getFilesystem

public ProjectFilesystem getFilesystem()

mkdirs

public void mkdirs(Path target)
            throws IOException

Create a directory and all of its parents

Parameters:

target - The path where a directory should exist

Throws:

IOException - If the directory could not be created

forcefullyCreateDirs

public void forcefullyCreateDirs(Path target)
                          throws IOException

Force a directory to be created. This will delete existing files (not directories) if they share the name of the directory, including parent paths

Parameters:

target - The path where a directory should exist

Throws:

IOException - The directory could not be created, or files that needed to be removed could not be removed