org.mini2Dx.core.files

Interface FileHandle

All Known Implementing Classes:

LibgdxFileHandle

public interface FileHandle

Method Summary

Modifier and Type	Method and Description
FileHandle	child(java.lang.String name) Returns a handle to the child with the specified name.
void	copyTo(FileHandle dest) Copies this file or directory to the specified file or directory.
boolean	delete() Deletes this file or empty directory and returns success.
boolean	deleteDirectory() Deletes this file or directory and all children, recursively.
void	emptyDirectory() Deletes all children of this directory, recursively.
void	emptyDirectory(boolean preserveTree) Deletes all children of this directory, recursively.
boolean	exists() Returns true if the file exists.
java.lang.String	extension()
boolean	isDirectory() Returns true if this file is a directory.
long	lastModified() Returns the last modified time in milliseconds for this file.
long	length() Returns the length in bytes of this file, or 0 if this file is a directory, does not exist, or the size cannot otherwise be determined.
FileHandle[]	list() Returns the paths to the children of this directory.
FileHandle[]	list(java.io.FileFilter filter) Returns the paths to the children of this directory that satisfy the specified filter.
FileHandle[]	list(java.io.FilenameFilter filter) Returns the paths to the children of this directory that satisfy the specified filter.
FileHandle[]	list(java.lang.String suffix) Returns the paths to the children of this directory with the specified suffix.
void	mkdirs()
void	moveTo(FileHandle dest) Moves this file to the specified file, overwriting the file if it already exists.
java.lang.String	name()
java.lang.String	nameWithoutExtension()
java.lang.String	normalize() Returns the path with redundant path elements removed (i.e.
FileHandle	normalizedHandle() Returns this FileHandle resolved with a normalised path
FileHandle	parent()
java.lang.String	path()
java.lang.String	pathWithoutExtension()
java.io.InputStream	read() Returns a stream for reading this file as bytes.
java.io.BufferedInputStream	read(int bufferSize) Returns a buffered stream for reading this file as bytes.
byte[]	readBytes() Reads the entire file into a byte array.
int	readBytes(byte[] bytes, int offset, int size) Reads the entire file into the byte array.
java.io.Reader	reader() Returns a reader for reading this file as characters.
java.io.BufferedReader	reader(int bufferSize) Returns a buffered reader for reading this file as characters.
java.io.BufferedReader	reader(int bufferSize, java.lang.String charset) Returns a buffered reader for reading this file as characters.
java.io.Reader	reader(java.lang.String charset) Returns a reader for reading this file as characters.
java.lang.String	readString() Reads the entire file into a string using the platform's default charset.
java.lang.String	readString(java.lang.String charset) Reads the entire file into a string using the specified charset.
FileHandle	sibling(java.lang.String name) Returns a handle to the sibling with the specified name.
FileType	type()
java.io.OutputStream	write(boolean append) Returns a stream for writing to this file.
java.io.OutputStream	write(boolean append, int bufferSize) Returns a buffered stream for writing to this file.
void	write(java.io.InputStream input, boolean append) Reads the remaining bytes from the specified stream and writes them to this file.
void	writeBytes(byte[] bytes, boolean append) Writes the specified bytes to the file.
void	writeBytes(byte[] bytes, int offset, int length, boolean append) Writes the specified bytes to the file.
java.io.Writer	writer(boolean append) Returns a writer for writing to this file using the default charset.
java.io.Writer	writer(boolean append, java.lang.String charset) Returns a writer for writing to this file.
void	writeString(java.lang.String string, boolean append) Writes the specified string to the file using the default charset.
void	writeString(java.lang.String string, boolean append, java.lang.String charset) Writes the specified string to the file using the specified charset.

Method Detail

path

java.lang.String path()

Returns:

the path of the file as specified on construction, e.g. Gdx.files.internal("dir/file.png") -> dir/file.png. backward slashes will be replaced by forward slashes.

normalize

java.lang.String normalize()

Returns the path with redundant path elements removed (i.e. dir/dir2/../file.png -> dir/file.png)

Returns:

normalizedHandle

FileHandle normalizedHandle()

Returns this FileHandle resolved with a normalised path

Returns:

name

java.lang.String name()

Returns:

the name of the file, without any parent paths.

extension

java.lang.String extension()

nameWithoutExtension

java.lang.String nameWithoutExtension()

Returns:

the name of the file, without parent paths or the extension.

pathWithoutExtension

java.lang.String pathWithoutExtension()

Returns:

the path and filename without the extension, e.g. dir/dir2/file.png -> dir/dir2/file. backward slashes will be returned as forward slashes.

type

FileType type()

read

java.io.InputStream read()
                  throws java.io.IOException

Returns a stream for reading this file as bytes.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

read

java.io.BufferedInputStream read(int bufferSize)
                          throws java.io.IOException

Returns a buffered stream for reading this file as bytes.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

reader

java.io.Reader reader()
               throws java.io.IOException

Returns a reader for reading this file as characters.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

reader

java.io.Reader reader(java.lang.String charset)
               throws java.io.IOException

Returns a reader for reading this file as characters.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

reader

java.io.BufferedReader reader(int bufferSize)
                       throws java.io.IOException

Returns a buffered reader for reading this file as characters.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

reader

java.io.BufferedReader reader(int bufferSize,
                              java.lang.String charset)
                       throws java.io.IOException

Returns a buffered reader for reading this file as characters.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

readString

java.lang.String readString()
                     throws java.io.IOException

Reads the entire file into a string using the platform's default charset.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

readString

java.lang.String readString(java.lang.String charset)
                     throws java.io.IOException

Reads the entire file into a string using the specified charset.

Parameters:

charset - If null the default charset is used.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

readBytes

byte[] readBytes()
          throws java.io.IOException

Reads the entire file into a byte array.

Throws:

java.io.IOException - if the file handle represents a directory, doesn't exist, or could not be read.

readBytes

int readBytes(byte[] bytes,
              int offset,
              int size)
       throws java.io.IOException

Reads the entire file into the byte array. The byte array must be big enough to hold the file's data.

Parameters:

bytes - the array to load the file into

offset - the offset to start writing bytes

size - the number of bytes to read, see length()

Returns:

the number of read bytes

Throws:

java.io.IOException

write

java.io.OutputStream write(boolean append)
                    throws java.io.IOException

Returns a stream for writing to this file. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

write

java.io.OutputStream write(boolean append,
                           int bufferSize)
                    throws java.io.IOException

Returns a buffered stream for writing to this file. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

bufferSize - The size of the buffer.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

write

void write(java.io.InputStream input,
           boolean append)
    throws java.io.IOException

Reads the remaining bytes from the specified stream and writes them to this file. The stream is closed. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

writer

java.io.Writer writer(boolean append)
               throws java.io.IOException

Returns a writer for writing to this file using the default charset. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

writer

java.io.Writer writer(boolean append,
                      java.lang.String charset)
               throws java.io.IOException

Returns a writer for writing to this file. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

charset - May be null to use the default charset.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

writeString

void writeString(java.lang.String string,
                 boolean append)
          throws java.io.IOException

Writes the specified string to the file using the default charset. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

writeString

void writeString(java.lang.String string,
                 boolean append,
                 java.lang.String charset)
          throws java.io.IOException

Writes the specified string to the file using the specified charset. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

charset - May be null to use the default charset.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

writeBytes

void writeBytes(byte[] bytes,
                boolean append)
         throws java.io.IOException

Writes the specified bytes to the file. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

writeBytes

void writeBytes(byte[] bytes,
                int offset,
                int length,
                boolean append)
         throws java.io.IOException

Writes the specified bytes to the file. Parent directories will be created if necessary.

Parameters:

append - If false, this file will be overwritten if it exists, otherwise it will be appended.

Throws:

java.io.IOException - if this file handle represents a directory, if it is a FileType.INTERNAL file, or if it could not be written.

list

FileHandle[] list()
           throws java.io.IOException

Returns the paths to the children of this directory. Returns an empty list if this file handle represents a file and not a directory. On the desktop, an FileType.INTERNAL handle to a directory on the classpath will return a zero length array.

Throws:

java.io.IOException

list

FileHandle[] list(java.io.FileFilter filter)
           throws java.io.IOException

Returns the paths to the children of this directory that satisfy the specified filter. Returns an empty list if this file handle represents a file and not a directory. On the desktop, an FileType.INTERNAL handle to a directory on the classpath will return a zero length array.

Parameters:

filter - the FileFilter to filter files

Throws:

java.io.IOException

list

FileHandle[] list(java.io.FilenameFilter filter)
           throws java.io.IOException

Returns the paths to the children of this directory that satisfy the specified filter. Returns an empty list if this file handle represents a file and not a directory. On the desktop, an FileType.INTERNAL handle to a directory on the classpath will return a zero length array.

Parameters:

filter - the FilenameFilter to filter files

Throws:

java.io.IOException

list

FileHandle[] list(java.lang.String suffix)
           throws java.io.IOException

Returns the paths to the children of this directory with the specified suffix. Returns an empty list if this file handle represents a file and not a directory. On the desktop, an FileType.INTERNAL handle to a directory on the classpath will return a zero length array.

Throws:

java.io.IOException

isDirectory

boolean isDirectory()

Returns true if this file is a directory. Always returns false for classpath files. On Android, an FileType.INTERNAL handle to an empty directory will return false. On the desktop, an FileType.INTERNAL handle to a directory on the classpath will return false.

child

FileHandle child(java.lang.String name)

Returns a handle to the child with the specified name.

sibling

FileHandle sibling(java.lang.String name)

Returns a handle to the sibling with the specified name.

parent

FileHandle parent()

mkdirs

void mkdirs()
     throws java.io.IOException

Throws:

java.io.IOException - if this file handle is a FileType.INTERNAL file.

exists

boolean exists()

Returns true if the file exists. On Android, a FileType.INTERNAL handle to a directory will always return false. Note that this can be very slow for internal files on Android!

delete

boolean delete()
        throws java.io.IOException

Deletes this file or empty directory and returns success. Will not delete a directory that has children.

Throws:

java.io.IOException - if this file handle is a FileType.INTERNAL file.

deleteDirectory

boolean deleteDirectory()
                 throws java.io.IOException

Deletes this file or directory and all children, recursively.

Throws:

java.io.IOException - if this file handle is a FileType.INTERNAL file.

emptyDirectory

void emptyDirectory()
             throws java.io.IOException

Deletes all children of this directory, recursively.

Throws:

java.io.IOException - if this file handle is a FileType.INTERNAL file.

emptyDirectory

void emptyDirectory(boolean preserveTree)
             throws java.io.IOException

Deletes all children of this directory, recursively. Optionally preserving the folder structure.

Throws:

java.io.IOException - if this file handle is a FileType.INTERNAL file.

copyTo

void copyTo(FileHandle dest)
     throws java.io.IOException

Copies this file or directory to the specified file or directory. If this handle is a file, then 1) if the destination is a file, it is overwritten, or 2) if the destination is a directory, this file is copied into it, or 3) if the destination doesn't exist, mkdirs() is called on the destination's parent and this file is copied into it with a new name. If this handle is a directory, then 1) if the destination is a file, IOException is thrown, or 2) if the destination is a directory, this directory is copied into it recursively, overwriting existing files, or 3) if the destination doesn't exist, mkdirs() is called on the destination and this directory is copied into it recursively.

Throws:

java.io.IOException - if the destination file handle is a FileType.INTERNAL file, or copying failed.

moveTo

void moveTo(FileHandle dest)
     throws java.io.IOException

Moves this file to the specified file, overwriting the file if it already exists.

Throws:

java.io.IOException - if the source or destination file handle is a FileType.INTERNAL file.

length

long length()

Returns the length in bytes of this file, or 0 if this file is a directory, does not exist, or the size cannot otherwise be determined.

lastModified

long lastModified()

Returns the last modified time in milliseconds for this file. Zero is returned if the file doesn't exist. Zero is returned for FileType.INTERNAL files.