|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.hadoop.fs.FileUtil
public class FileUtil
A collection of file-processing util methods
Constructor Summary | |
---|---|
FileUtil()
|
Method Summary | |
---|---|
static int |
chmod(String filename,
String perm)
Change the permissions on a filename. |
static int |
chmod(String filename,
String perm,
boolean recursive)
Change the permissions on a file / directory, recursively, if needed. |
static boolean |
copy(File src,
FileSystem dstFS,
Path dst,
boolean deleteSource,
Configuration conf)
Copy local files to a FileSystem. |
static boolean |
copy(FileSystem srcFS,
Path[] srcs,
FileSystem dstFS,
Path dst,
boolean deleteSource,
boolean overwrite,
Configuration conf)
|
static boolean |
copy(FileSystem srcFS,
Path src,
File dst,
boolean deleteSource,
Configuration conf)
Copy FileSystem files to local files. |
static boolean |
copy(FileSystem srcFS,
Path src,
FileSystem dstFS,
Path dst,
boolean deleteSource,
boolean overwrite,
Configuration conf)
Copy files between FileSystems. |
static boolean |
copy(FileSystem srcFS,
Path src,
FileSystem dstFS,
Path dst,
boolean deleteSource,
Configuration conf)
Copy files between FileSystems. |
static boolean |
copyMerge(FileSystem srcFS,
Path srcDir,
FileSystem dstFS,
Path dstFile,
boolean deleteSource,
Configuration conf,
String addString)
Copy all files in a directory to one output file (merge). |
static File |
createLocalTempFile(File basefile,
String prefix,
boolean isDeleteOnExit)
Create a tmp file for a base file. |
static boolean |
fullyDelete(File dir)
Delete a directory and all its contents. |
static void |
fullyDelete(FileSystem fs,
Path dir)
Deprecated. Use FileSystem.delete(Path, boolean) |
static boolean |
fullyDeleteContents(File dir)
Delete the contents of a directory, not the directory itself. |
static long |
getDU(File dir)
Takes an input dir and returns the du on that local directory. |
static String[] |
list(File dir)
A wrapper for File.list() . |
static File[] |
listFiles(File dir)
A wrapper for File.listFiles() . |
static String |
makeShellPath(File file)
Convert a os-native filename to a path that works for the shell. |
static String |
makeShellPath(File file,
boolean makeCanonicalPath)
Convert a os-native filename to a path that works for the shell. |
static String |
makeShellPath(String filename)
Convert a os-native filename to a path that works for the shell. |
static void |
replaceFile(File src,
File target)
Move the src file to the name specified by target. |
static void |
setPermission(File f,
FsPermission permission)
Set permissions to the required value. |
static Path[] |
stat2Paths(FileStatus[] stats)
convert an array of FileStatus to an array of Path |
static Path[] |
stat2Paths(FileStatus[] stats,
Path path)
convert an array of FileStatus to an array of Path. |
static int |
symLink(String target,
String linkname)
Create a soft link between a src and destination only on a local disk. |
static void |
unTar(File inFile,
File untarDir)
Given a Tar File as input it will untar the file in a the untar directory passed as the second parameter This utility will untar ".tar" files and ".tar.gz","tgz" files. |
static void |
unZip(File inFile,
File unzipDir)
Given a File input it will unzip the file in a the unzip directory passed as the second parameter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileUtil()
Method Detail |
---|
public static Path[] stat2Paths(FileStatus[] stats)
stats
- an array of FileStatus objects
public static Path[] stat2Paths(FileStatus[] stats, Path path)
stats
- an array of FileStatus objectspath
- default path to return in stats is null
public static boolean fullyDelete(File dir) throws IOException
IOException
public static boolean fullyDeleteContents(File dir) throws IOException
IOException
@Deprecated public static void fullyDelete(FileSystem fs, Path dir) throws IOException
FileSystem.delete(Path, boolean)
fs
- FileSystem
on which the path is presentdir
- directory to recursively delete
IOException
public static boolean copy(FileSystem srcFS, Path src, FileSystem dstFS, Path dst, boolean deleteSource, Configuration conf) throws IOException
IOException
public static boolean copy(FileSystem srcFS, Path[] srcs, FileSystem dstFS, Path dst, boolean deleteSource, boolean overwrite, Configuration conf) throws IOException
IOException
public static boolean copy(FileSystem srcFS, Path src, FileSystem dstFS, Path dst, boolean deleteSource, boolean overwrite, Configuration conf) throws IOException
IOException
public static boolean copyMerge(FileSystem srcFS, Path srcDir, FileSystem dstFS, Path dstFile, boolean deleteSource, Configuration conf, String addString) throws IOException
IOException
public static boolean copy(File src, FileSystem dstFS, Path dst, boolean deleteSource, Configuration conf) throws IOException
IOException
public static boolean copy(FileSystem srcFS, Path src, File dst, boolean deleteSource, Configuration conf) throws IOException
IOException
public static String makeShellPath(String filename) throws IOException
filename
- The filename to convert
IOException
- on windows, there can be problems with the subprocesspublic static String makeShellPath(File file) throws IOException
file
- The filename to convert
IOException
- on windows, there can be problems with the subprocesspublic static String makeShellPath(File file, boolean makeCanonicalPath) throws IOException
file
- The filename to convertmakeCanonicalPath
- Whether to make canonical path for the file passed
IOException
- on windows, there can be problems with the subprocesspublic static long getDU(File dir)
dir
- The input dir to get the disk space of this local dir
public static void unZip(File inFile, File unzipDir) throws IOException
inFile
- The zip file as inputunzipDir
- The unzip directory where to unzip the zip file.
IOException
public static void unTar(File inFile, File untarDir) throws IOException
inFile
- The tar file as input.untarDir
- The untar directory where to untar the tar file.
IOException
public static int symLink(String target, String linkname) throws IOException
target
- the target for symlinklinkname
- the symlink
IOException
public static int chmod(String filename, String perm) throws IOException, InterruptedException
filename
- the name of the file to changeperm
- the permission string
IOException
InterruptedException
public static int chmod(String filename, String perm, boolean recursive) throws IOException
filename
- name of the file whose permissions are to changeperm
- permission stringrecursive
- true, if permissions should be changed recursively
IOException
InterruptedException
public static void setPermission(File f, FsPermission permission) throws IOException
f
- the file to changepermission
- the new permissions
IOException
public static final File createLocalTempFile(File basefile, String prefix, boolean isDeleteOnExit) throws IOException
basefile
- the base file of the tmpprefix
- file name prefix of tmpisDeleteOnExit
- if true, the tmp will be deleted when the VM exits
IOException
- If a tmp file cannot createdFile.createTempFile(String, String, File)
,
File.deleteOnExit()
public static void replaceFile(File src, File target) throws IOException
src
- the source filetarget
- the target file
IOException
- If this operation failspublic static File[] listFiles(File dir) throws IOException
File.listFiles()
. This java.io API returns null
when a dir is not a directory or for any I/O error. Instead of having
null check everywhere File#listFiles() is used, we will add utility API
to get around this problem. For the majority of cases where we prefer
an IOException to be thrown.
dir
- directory for which listing should be performed
IOException
- for invalid directory or for a bad disk.public static String[] list(File dir) throws IOException
File.list()
. This java.io API returns null
when a dir is not a directory or for any I/O error. Instead of having
null check everywhere File#list() is used, we will add utility API
to get around this problem. For the majority of cases where we prefer
an IOException to be thrown.
dir
- directory for which listing should be performed
IOException
- for invalid directory or for a bad disk.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |