com.android.repository.testframework

Class MockFileOp

java.lang.Object

com.android.repository.io.impl.FileSystemFileOp

com.android.repository.testframework.MockFileOp

All Implemented Interfaces:

FileOp

public class MockFileOp
extends FileSystemFileOp

Mock version of FileOpImpl that wraps some common File operations on files and folders.

This version does not perform any file operation. Instead it records a textual representation of all the file operations performed.

To avoid cross-platform path issues (e.g. Windows path), the methods here should always use rooted (aka absolute) unix-looking paths, e.g. "/dir1/dir2/file3". When processing File, you can convert them using getAgnosticAbsPath(File).

Field Summary

Fields inherited from class com.android.repository.io.impl.FileSystemFileOp

mIsWindows

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

EMPTY_FILE_ARRAY

Constructor Summary

Constructors

Constructor and Description
MockFileOp()

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(java.io.File file) Invokes File.canWrite() on the given file.
void	deleteOnExit(java.io.File file)
java.io.File	ensureRealFile(java.io.File in) If in is an in-memory file, write it out as a proper file and return it.
java.lang.String	getAgnosticAbsPath(java.io.File file)
java.lang.String	getAgnosticAbsPath(java.lang.String path)
byte[]	getContent(java.io.File file)
java.lang.String[]	getExistingFiles() Returns the list of paths added using recordExistingFile(String) and eventually updated by FileSystemFileOp.delete(File) operations.
java.lang.String[]	getExistingFolders() Returns the list of folder paths added using recordExistingFolder(String) and eventually updated FileSystemFileOp.delete(File) or FileSystemFileOp.mkdirs(File) operations.
java.nio.file.FileSystem	getFileSystem() Gets the FileSystem this is based on.
boolean	hasRecordedExistingFolder(java.io.File folder) Returns true if a folder with the given path has been recorded.
void	recordExistingFile(java.io.File file) Records a new absolute file path.
void	recordExistingFile(java.lang.String absFilePath) Records a new absolute file path.
void	recordExistingFile(java.lang.String absFilePath, byte[] inputStream) Records a new absolute file path and its input stream content.
void	recordExistingFile(java.lang.String absFilePath, long lastModified, byte[] inputStream) Records a new absolute file path and its input stream content.
void	recordExistingFile(java.lang.String absFilePath, long lastModified, java.lang.String content) Records a new absolute file path and its input stream content.
void	recordExistingFile(java.lang.String absFilePath, java.lang.String content) Records a new absolute file path and its input stream content.
void	recordExistingFolder(java.io.File folder) Records a new absolute folder path.
void	recordExistingFolder(java.lang.String absFolderPath) Records a new absolute folder path.
void	reset() Resets the internal state, as if the object had been newly created.
void	setIsWindows(boolean isWindows)
java.nio.file.Path	toPath(java.io.File file) Convert the given File into a Path, using some means appropriate to this FileOp.

Methods inherited from class com.android.repository.io.impl.FileSystemFileOp

canExecute, copyFile, createNewFile, delete, deleteFileOrFolder, exists, isDirectory, isFile, isSameFile, isWindows, lastModified, length, list, listFiles, listFiles, mkdirs, newFileInputStream, newFileOutputStream, newFileOutputStream, renameTo, setExecutablePermission, setLastModified, setReadOnly, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MockFileOp

public MockFileOp()

Method Detail

getFileSystem

public java.nio.file.FileSystem getFileSystem()

Description copied from class: FileSystemFileOp

Gets the FileSystem this is based on.

Specified by:

getFileSystem in class FileSystemFileOp

Returns:

reset

public void reset()

Resets the internal state, as if the object had been newly created.

deleteOnExit

public void deleteOnExit(java.io.File file)

See Also:

File.deleteOnExit()

setIsWindows

public void setIsWindows(boolean isWindows)

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

Overrides:

canWrite in class FileSystemFileOp

getAgnosticAbsPath

@NonNull
public java.lang.String getAgnosticAbsPath(@NonNull
                                                    java.io.File file)

getAgnosticAbsPath

@NonNull
public java.lang.String getAgnosticAbsPath(@NonNull
                                                    java.lang.String path)

recordExistingFile

public void recordExistingFile(@NonNull
                               java.io.File file)

Records a new absolute file path. Parent folders are automatically created.

recordExistingFile

public void recordExistingFile(@NonNull
                               java.lang.String absFilePath)

Records a new absolute file path. Parent folders are automatically created.

The syntax should always look "unix-like", e.g. "/dir/file". On Windows that means you'll want to use getAgnosticAbsPath(File).

Parameters:

absFilePath - A unix-like file path, e.g. "/dir/file"

recordExistingFile

public void recordExistingFile(@NonNull
                               java.lang.String absFilePath,
                               @Nullable
                               byte[] inputStream)

Records a new absolute file path and its input stream content. Parent folders are automatically created.

The syntax should always look "unix-like", e.g. "/dir/file". On Windows that means you'll want to use getAgnosticAbsPath(File).

Parameters:

absFilePath - A unix-like file path, e.g. "/dir/file"

inputStream - A non-null byte array of content to return via FileSystemFileOp.newFileInputStream(File).

recordExistingFile

public void recordExistingFile(@NonNull
                               java.lang.String absFilePath,
                               @NonNull
                               java.lang.String content)

Records a new absolute file path and its input stream content. Parent folders are automatically created.

The syntax should always look "unix-like", e.g. "/dir/file". On Windows that means you'll want to use getAgnosticAbsPath(File).

Parameters:

absFilePath - A unix-like file path, e.g. "/dir/file"

content - A non-null UTF-8 content string to return via FileSystemFileOp.newFileInputStream(File).

recordExistingFile

public void recordExistingFile(@NonNull
                               java.lang.String absFilePath,
                               long lastModified,
                               @Nullable
                               byte[] inputStream)

Records a new absolute file path and its input stream content. Parent folders are automatically created.

The syntax should always look "unix-like", e.g. "/dir/file". On Windows that means you'll want to use getAgnosticAbsPath(File).

Parameters:

absFilePath - A unix-like file path, e.g. "/dir/file"

inputStream - A non-null byte array of content to return via FileSystemFileOp.newFileInputStream(File).

recordExistingFile

public void recordExistingFile(@NonNull
                               java.lang.String absFilePath,
                               long lastModified,
                               @NonNull
                               java.lang.String content)

Records a new absolute file path and its input stream content. Parent folders are automatically created.

The syntax should always look "unix-like", e.g. "/dir/file". On Windows that means you'll want to use getAgnosticAbsPath(File).

Parameters:

absFilePath - A unix-like file path, e.g. "/dir/file"

content - A non-null UTF-8 content string to return via FileSystemFileOp.newFileInputStream(File).

recordExistingFolder

public void recordExistingFolder(java.io.File folder)

Records a new absolute folder path. Parent folders are automatically created.

recordExistingFolder

public void recordExistingFolder(java.lang.String absFolderPath)

Records a new absolute folder path. Parent folders are automatically created.

The syntax should always look "unix-like", e.g. "/dir/file". On Windows that means you'll want to use getAgnosticAbsPath(File).

Parameters:

absFolderPath - A unix-like folder path, e.g. "/dir/file"

hasRecordedExistingFolder

public boolean hasRecordedExistingFolder(java.io.File folder)

Returns true if a folder with the given path has been recorded.

getExistingFiles

@NonNull
public java.lang.String[] getExistingFiles()

Returns the list of paths added using recordExistingFile(String) and eventually updated by FileSystemFileOp.delete(File) operations.

The returned list is sorted by alphabetic absolute path string.

getExistingFolders

@NonNull
public java.lang.String[] getExistingFolders()

Returns the list of folder paths added using recordExistingFolder(String) and eventually updated FileSystemFileOp.delete(File) or FileSystemFileOp.mkdirs(File) operations.

The returned list is sorted by alphabetic absolute path string.

ensureRealFile

public java.io.File ensureRealFile(@NonNull
                                   java.io.File in)
                            throws java.io.IOException

Description copied from interface: FileOp

If in is an in-memory file, write it out as a proper file and return it. Otherwise just return in.

Throws:

java.io.IOException

getContent

public byte[] getContent(java.io.File file)

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

Overrides:

toPath in class FileSystemFileOp