com.android.repository.io.impl

Class FileSystemFileOp

java.lang.Object

com.android.repository.io.impl.FileSystemFileOp

All Implemented Interfaces:

FileOp

Direct Known Subclasses:

FileOpImpl, MockFileOp

public abstract class FileSystemFileOp
extends java.lang.Object
implements FileOp

Base class for FileOp implementations based on a FileSystem.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mIsWindows

Fields inherited from interface com.android.repository.io.FileOp

EMPTY_FILE_ARRAY

Constructor Summary

Constructors

Constructor and Description
FileSystemFileOp()

Method Summary

Modifier and Type	Method and Description
boolean	canExecute(java.io.File file)
boolean	canWrite(java.io.File file) Invokes File.canWrite() on the given file.
void	copyFile(java.io.File source, java.io.File dest) Copies a binary file.
boolean	createNewFile(java.io.File file) Creates a new 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.
abstract java.nio.file.FileSystem	getFileSystem() Gets the FileSystem this is based on.
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.
boolean	isWindows() Returns true if we're on windows, false otherwise.
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.lang.String[]	list(java.io.File folder, java.io.FilenameFilter filenameFilter)
java.io.File[]	listFiles(java.io.File file) Invokes File.listFiles() on the given file.
java.io.File[]	listFiles(java.io.File folder, java.io.FilenameFilter filenameFilter)
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.
java.io.OutputStream	newFileOutputStream(java.io.File file, boolean append) 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	setExecutablePermission(java.io.File file) Sets the executable Unix permission (+x) on a file or folder.
boolean	setLastModified(java.io.File file, long time)
void	setReadOnly(java.io.File file) Sets the file or directory as read-only.
java.nio.file.Path	toPath(java.io.File file) Convert the given File into a Path, using some means appropriate to this FileOp.
java.lang.String	toString(java.io.File f, java.nio.charset.Charset c)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.repository.io.FileOp

deleteOnExit, ensureRealFile

Field Detail

mIsWindows

protected boolean mIsWindows

Constructor Detail

FileSystemFileOp

public FileSystemFileOp()

Method Detail

getFileSystem

public abstract java.nio.file.FileSystem getFileSystem()

Gets the FileSystem this is based on.

Returns:

isWindows

public final boolean isWindows()

Description copied from interface: FileOp

Returns true if we're on windows, false otherwise.

Specified by:

isWindows in interface FileOp

toString

@NonNull
public final java.lang.String toString(@NonNull
                                                java.io.File f,
                                                @NonNull
                                                java.nio.charset.Charset c)
                                         throws java.io.IOException

Specified by:

toString in interface FileOp

Throws:

java.io.IOException

See Also:

Files.toString(File, Charset)

list

@Nullable
public final java.lang.String[] list(@NonNull
                                               java.io.File folder,
                                               @Nullable
                                               java.io.FilenameFilter filenameFilter)

Specified by:

list in interface FileOp

See Also:

File.list(FilenameFilter)

listFiles

@Nullable
public final java.io.File[] listFiles(@NonNull
                                                java.io.File folder,
                                                @Nullable
                                                java.io.FilenameFilter filenameFilter)

Specified by:

listFiles in interface FileOp

See Also:

File.listFiles(FilenameFilter)

setLastModified

public final boolean setLastModified(@NonNull
                                     java.io.File file,
                                     long time)
                              throws java.io.IOException

Specified by:

setLastModified in interface FileOp

Throws:

java.io.IOException - if there is an error setting the modification time.

See Also:

File.setLastModified(long)

deleteFileOrFolder

public final void deleteFileOrFolder(@NonNull
                                     java.io.File fileOrFolder)

Description copied from interface: FileOp

Helper to delete a file or a directory. For a directory, recursively deletes all of its content. Files that cannot be deleted right away are marked for deletion on exit. It's ok for the file or folder to not exist at all.

Specified by:

deleteFileOrFolder in interface FileOp

setExecutablePermission

public final void setExecutablePermission(@NonNull
                                          java.io.File file)
                                   throws java.io.IOException

Description copied from interface: FileOp

Sets the executable Unix permission (+x) on a file or folder.

This attempts to use File#setExecutable through reflection if it's available. If this is not available, this invokes a chmod exec instead, so there is no guarantee of it being fast.

Caller must make sure to not invoke this under Windows.

Specified by:

setExecutablePermission in interface FileOp

Parameters:

file - The file to set permissions on.

Throws:

java.io.IOException - If an I/O error occurs

canExecute

public final boolean canExecute(@NonNull
                                java.io.File file)

Specified by:

canExecute in interface FileOp

See Also:

File.canExecute()

setReadOnly

public void setReadOnly(@NonNull
                        java.io.File file)
                 throws java.io.IOException

Description copied from interface: FileOp

Sets the file or directory as read-only.

Specified by:

setReadOnly in interface FileOp

Parameters:

file - The file or directory to set permissions on.

Throws:

java.io.IOException

copyFile

public void copyFile(@NonNull
                     java.io.File source,
                     @NonNull
                     java.io.File dest)
              throws java.io.IOException

Description copied from interface: FileOp

Copies a binary file.

Specified by:

copyFile in interface FileOp

Parameters:

source - the source file to copy.

dest - the destination file to write.

Throws:

java.io.FileNotFoundException - if the source file doesn't exist.

java.io.IOException - if there's a problem reading or writing the file.

isSameFile

public final boolean isSameFile(@NonNull
                                java.io.File file1,
                                @NonNull
                                java.io.File file2)
                         throws java.io.IOException

Description copied from interface: FileOp

Checks whether 2 binary files are the same.

Specified by:

isSameFile in interface FileOp

Parameters:

file1 - the source file to copy

file2 - the destination file to write

Throws:

java.io.FileNotFoundException - if the source files don't exist.

java.io.IOException - if there's a problem reading the files.

isFile

public final boolean isFile(@NonNull
                            java.io.File file)

Description copied from interface: FileOp

Invokes File.isFile() on the given file.

Specified by:

isFile in interface FileOp

isDirectory

public final boolean isDirectory(@NonNull
                                 java.io.File file)

Description copied from interface: FileOp

Invokes File.isDirectory() on the given file.

Specified by:

isDirectory in interface FileOp

canWrite

public boolean canWrite(@NonNull
                        java.io.File file)

Description copied from interface: FileOp

Invokes File.canWrite() on the given file.

Specified by:

canWrite in interface FileOp

exists

public final boolean exists(@NonNull
                            java.io.File file)

Description copied from interface: FileOp

Invokes File.exists() on the given file.

Specified by:

exists in interface FileOp

length

public final long length(@NonNull
                         java.io.File file)
                  throws java.io.IOException

Description copied from interface: FileOp

Invokes File.length() on the given file.

Specified by:

length in interface FileOp

Throws:

java.io.IOException

delete

public boolean delete(@NonNull
                      java.io.File file)

Description copied from interface: FileOp

Invokes File.delete() on the given file. Note: for a recursive folder version, consider FileOp.deleteFileOrFolder(File).

Specified by:

delete in interface FileOp

mkdirs

public final boolean mkdirs(@NonNull
                            java.io.File file)

Description copied from interface: FileOp

Invokes File.mkdirs() on the given file.

Specified by:

mkdirs in interface FileOp

listFiles

@NonNull
public final java.io.File[] listFiles(@NonNull
                                               java.io.File file)

Description copied from interface: FileOp

Invokes 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.

Specified by:

listFiles in interface FileOp

renameTo

public boolean renameTo(@NonNull
                        java.io.File oldFile,
                        @NonNull
                        java.io.File newFile)

Description copied from interface: FileOp

Invokes File.renameTo(File) on the given files.

Specified by:

renameTo in interface FileOp

newFileOutputStream

@NonNull
public java.io.OutputStream newFileOutputStream(@NonNull
                                                         java.io.File file)
                                                  throws java.io.IOException

Description copied from interface: FileOp

Creates a new OutputStream for the given file.

Specified by:

newFileOutputStream in interface FileOp

Throws:

java.io.IOException

newFileOutputStream

@NonNull
public java.io.OutputStream newFileOutputStream(@NonNull
                                                         java.io.File file,
                                                         boolean append)
                                                  throws java.io.IOException

Description copied from interface: FileOp

Creates a new OutputStream for the given file.

Specified by:

newFileOutputStream in interface FileOp

Throws:

java.io.IOException

newFileInputStream

@NonNull
public final java.io.InputStream newFileInputStream(@NonNull
                                                             java.io.File file)
                                                      throws java.io.IOException

Description copied from interface: FileOp

Creates a new InputStream for the given file.

Specified by:

newFileInputStream in interface FileOp

Throws:

java.io.IOException

lastModified

public final long lastModified(@NonNull
                               java.io.File file)

Description copied from interface: FileOp

Returns the lastModified attribute of the file.

Specified by:

lastModified in interface FileOp

Parameters:

file - The non-null file of which to retrieve the lastModified attribute.

Returns:

The last-modified attribute of the file, in milliseconds since The Epoch.

See Also:

File.lastModified()

createNewFile

public final boolean createNewFile(@NonNull
                                   java.io.File file)
                            throws java.io.IOException

Description copied from interface: FileOp

Creates a new file. See File.createNewFile().

Specified by:

createNewFile in interface FileOp

Throws:

java.io.IOException

toPath

@NonNull
public java.nio.file.Path toPath(@NonNull
                                          java.io.File file)

Description copied from interface: FileOp

Convert the given File into a Path, using some means appropriate to this FileOp.

Specified by:

toPath in interface FileOp