|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.android.sdklib.io.FileOp
public class FileOp
Wraps some common File
operations on files and folders.
Field Summary | |
---|---|
static java.io.File[] |
EMPTY_FILE_ARRAY
|
Constructor Summary | |
---|---|
FileOp()
|
Method Summary | |
---|---|
static java.io.File |
append(java.io.File base,
java.lang.String... segments)
Appends the given segments to the base file. |
static java.io.File |
append(java.lang.String base,
java.lang.String... segments)
Appends the given segments to the base file. |
void |
copyFile(java.io.File source,
java.io.File dest)
Copies a binary file. |
boolean |
delete(java.io.File file)
Invokes File.delete() on the given file . |
void |
deleteFileOrFolder(java.io.File fileOrFolder)
Helper to delete a file or a directory. |
boolean |
exists(java.io.File file)
Invokes File.exists() on the given file . |
boolean |
isDirectory(java.io.File file)
Invokes File.isDirectory() on the given file . |
boolean |
isFile(java.io.File file)
Invokes File.isFile() on the given file . |
boolean |
isSameFile(java.io.File file1,
java.io.File file2)
Checks whether 2 binary files are the same. |
long |
lastModified(java.io.File file)
Returns the lastModified attribute of the file. |
long |
length(java.io.File file)
Invokes File.length() on the given file . |
java.io.File[] |
listFiles(java.io.File file)
Invokes File.listFiles() on the given file . |
java.util.Properties |
loadProperties(java.io.File file)
Load Properties from a file. |
static java.lang.String |
makeRelative(java.io.File baseDir,
java.io.File toBeRelative)
Computes a relative path from "toBeRelative" relative to "baseDir". |
boolean |
mkdirs(java.io.File file)
Invokes File.mkdirs() on the given file . |
java.io.InputStream |
newFileInputStream(java.io.File file)
Creates a new InputStream for the given file . |
java.io.OutputStream |
newFileOutputStream(java.io.File file)
Creates a new OutputStream for the given file . |
boolean |
renameTo(java.io.File oldFile,
java.io.File newFile)
Invokes File.renameTo(File) on the given files. |
void |
saveProperties(java.io.File file,
java.util.Properties props,
java.lang.String comments)
Saves (write, store) the given Properties into the given File . |
void |
setExecutablePermission(java.io.File file)
Sets the executable Unix permission (+x) on a file or folder. |
void |
setReadOnly(java.io.File file)
Sets the file or directory as read-only. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.io.File[] EMPTY_FILE_ARRAY
Constructor Detail |
---|
public FileOp()
Method Detail |
---|
public static java.io.File append(@NonNull java.io.File base, @NonNull java.lang.String... segments)
segments
to the base
file.
base
- A base file, non-null.segments
- Individual folder or filename segments to append to the base file.
public static java.io.File append(@NonNull java.lang.String base, @NonNull java.lang.String... segments)
segments
to the base
file.
base
- A base file path, non-empty and non-null.segments
- Individual folder or filename segments to append to the base path.
public void deleteFileOrFolder(@NonNull java.io.File fileOrFolder)
deleteFileOrFolder
in interface IFileOp
public void setExecutablePermission(@NonNull java.io.File file) throws java.io.IOException
setExecutablePermission
in interface IFileOp
file
- The file to set permissions on.
java.io.IOException
- If an I/O error occurspublic void setReadOnly(@NonNull java.io.File file)
IFileOp
setReadOnly
in interface IFileOp
file
- The file or directory to set permissions on.public void copyFile(@NonNull java.io.File source, @NonNull java.io.File dest) throws java.io.IOException
copyFile
in interface IFileOp
source
- the source file to copy.dest
- the destination file to write.
java.io.FileNotFoundException
- if the source file doesn't exist.
java.io.IOException
- if there's a problem reading or writing the file.public boolean isSameFile(@NonNull java.io.File file1, @NonNull java.io.File file2) throws java.io.IOException
isSameFile
in interface IFileOp
file1
- the source file to copyfile2
- the destination file to write
java.io.FileNotFoundException
- if the source files don't exist.
java.io.IOException
- if there's a problem reading the files.public boolean isFile(@NonNull java.io.File file)
File.isFile()
on the given file
.
isFile
in interface IFileOp
public boolean isDirectory(@NonNull java.io.File file)
File.isDirectory()
on the given file
.
isDirectory
in interface IFileOp
public boolean exists(@NonNull java.io.File file)
File.exists()
on the given file
.
exists
in interface IFileOp
public long length(@NonNull java.io.File file)
File.length()
on the given file
.
length
in interface IFileOp
public boolean delete(@NonNull java.io.File file)
File.delete()
on the given file
.
Note: for a recursive folder version, consider deleteFileOrFolder(File)
.
delete
in interface IFileOp
public boolean mkdirs(@NonNull java.io.File file)
File.mkdirs()
on the given file
.
mkdirs
in interface IFileOp
@NonNull public java.io.File[] listFiles(@NonNull java.io.File file)
File.listFiles()
on the given file
.
Contrary to the Java API, this returns an empty array instead of null when the
directory does not exist.
listFiles
in interface IFileOp
public boolean renameTo(@NonNull java.io.File oldFile, @NonNull java.io.File newFile)
File.renameTo(File)
on the given files.
renameTo
in interface IFileOp
@NonNull public java.io.OutputStream newFileOutputStream(@NonNull java.io.File file) throws java.io.FileNotFoundException
OutputStream
for the given file
.
newFileOutputStream
in interface IFileOp
java.io.FileNotFoundException
@NonNull public java.io.InputStream newFileInputStream(@NonNull java.io.File file) throws java.io.FileNotFoundException
InputStream
for the given file
.
newFileInputStream
in interface IFileOp
java.io.FileNotFoundException
@NonNull public java.util.Properties loadProperties(@NonNull java.io.File file)
IFileOp
Properties
from a file. Returns an empty property set on error.
loadProperties
in interface IFileOp
file
- A non-null file to load from. File may not exist.
Properties
with the properties loaded from the file,
or an empty property set in case of error.public void saveProperties(@NonNull java.io.File file, @NonNull java.util.Properties props, @NonNull java.lang.String comments) throws java.io.IOException
IFileOp
Properties
into the given File
.
saveProperties
in interface IFileOp
file
- A non-null file to write to.props
- The properties to write.comments
- A non-null description of the properly list, written in the file.
java.io.IOException
- if the write operation failed.public long lastModified(@NonNull java.io.File file)
IFileOp
lastModified
in interface IFileOp
file
- The non-null file of which to retrieve the lastModified attribute.
File.lastModified()
@NonNull public static java.lang.String makeRelative(@NonNull java.io.File baseDir, @NonNull java.io.File toBeRelative) throws java.io.IOException
baseDir
- The base directory to be relative to.toBeRelative
- The file or directory to make relative to the base.
java.io.IOException
- If drive letters don't match on Windows or path canonicalization fails.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |