org.mini2Dx.libgdx.files

Class LibgdxFileHandle

java.lang.Object

org.mini2Dx.libgdx.files.LibgdxFileHandle

All Implemented Interfaces:

FileHandle

public class LibgdxFileHandle
extends java.lang.Object
implements FileHandle

Field Summary

Fields

Modifier and Type	Field and Description
com.badlogic.gdx.files.FileHandle	fileHandle

Constructor Summary

Constructors

Constructor and Description
LibgdxFileHandle(com.badlogic.gdx.files.FileHandle 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.

Methods inherited from class java.lang.Object

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

Field Detail

fileHandle

public final com.badlogic.gdx.files.FileHandle fileHandle

Constructor Detail

LibgdxFileHandle

public LibgdxFileHandle(com.badlogic.gdx.files.FileHandle fileHandle)

Method Detail

path

public java.lang.String path()

Specified by:

path in interface FileHandle

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

public java.lang.String normalize()

Description copied from interface: FileHandle

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

Specified by:

normalize in interface FileHandle

Returns:

normalizedHandle

public FileHandle normalizedHandle()

Description copied from interface: FileHandle

Returns this FileHandle resolved with a normalised path

Specified by:

normalizedHandle in interface FileHandle

Returns:

name

public java.lang.String name()

Specified by:

name in interface FileHandle

Returns:

the name of the file, without any parent paths.

extension

public java.lang.String extension()

Specified by:

extension in interface FileHandle

nameWithoutExtension

public java.lang.String nameWithoutExtension()

Specified by:

nameWithoutExtension in interface FileHandle

Returns:

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

pathWithoutExtension

public java.lang.String pathWithoutExtension()

Specified by:

pathWithoutExtension in interface FileHandle

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

public FileType type()

Specified by:

type in interface FileHandle

read

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

Description copied from interface: FileHandle

Returns a stream for reading this file as bytes.

Specified by:

read in interface FileHandle

Throws:

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

read

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

Description copied from interface: FileHandle

Returns a buffered stream for reading this file as bytes.

Specified by:

read in interface FileHandle

Throws:

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

reader

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

Description copied from interface: FileHandle

Returns a reader for reading this file as characters.

Specified by:

reader in interface FileHandle

Throws:

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

reader

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

Description copied from interface: FileHandle

Returns a reader for reading this file as characters.

Specified by:

reader in interface FileHandle

Throws:

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

reader

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

Description copied from interface: FileHandle

Returns a buffered reader for reading this file as characters.

Specified by:

reader in interface FileHandle

Throws:

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

reader

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

Description copied from interface: FileHandle

Returns a buffered reader for reading this file as characters.

Specified by:

reader in interface FileHandle

Throws:

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

readString

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

Description copied from interface: FileHandle

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

Specified by:

readString in interface FileHandle

Throws:

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

readString

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

Description copied from interface: FileHandle

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

Specified by:

readString in interface FileHandle

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

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

Description copied from interface: FileHandle

Reads the entire file into a byte array.

Specified by:

readBytes in interface FileHandle

Throws:

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

readBytes

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

Description copied from interface: FileHandle

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

Specified by:

readBytes in interface FileHandle

Parameters:

bytes - the array to load the file into

offset - the offset to start writing bytes

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

Returns:

the number of read bytes

Throws:

java.io.IOException

write

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

Description copied from interface: FileHandle

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

Specified by:

write in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

write in interface FileHandle

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

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

Description copied from interface: FileHandle

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.

Specified by:

write in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

writer in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

writer in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

writeString in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

writeString in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

writeBytes in interface FileHandle

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

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

Description copied from interface: FileHandle

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

Specified by:

writeBytes in interface FileHandle

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

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

Description copied from interface: FileHandle

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.

Specified by:

list in interface FileHandle

Throws:

java.io.IOException

list

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

Description copied from interface: FileHandle

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.

Specified by:

list in interface FileHandle

Parameters:

filter - the FileFilter to filter files

Throws:

java.io.IOException

list

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

Description copied from interface: FileHandle

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.

Specified by:

list in interface FileHandle

Parameters:

filter - the FilenameFilter to filter files

Throws:

java.io.IOException

list

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

Description copied from interface: FileHandle

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.

Specified by:

list in interface FileHandle

Throws:

java.io.IOException

isDirectory

public boolean isDirectory()

Description copied from interface: FileHandle

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.

Specified by:

isDirectory in interface FileHandle

child

public FileHandle child(java.lang.String name)

Description copied from interface: FileHandle

Returns a handle to the child with the specified name.

Specified by:

child in interface FileHandle

sibling

public FileHandle sibling(java.lang.String name)

Description copied from interface: FileHandle

Returns a handle to the sibling with the specified name.

Specified by:

sibling in interface FileHandle

parent

public FileHandle parent()

Specified by:

parent in interface FileHandle

mkdirs

public void mkdirs()
            throws java.io.IOException

Specified by:

mkdirs in interface FileHandle

Throws:

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

exists

public boolean exists()

Description copied from interface: FileHandle

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!

Specified by:

exists in interface FileHandle

delete

public boolean delete()
               throws java.io.IOException

Description copied from interface: FileHandle

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

Specified by:

delete in interface FileHandle

Throws:

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

deleteDirectory

public boolean deleteDirectory()
                        throws java.io.IOException

Description copied from interface: FileHandle

Deletes this file or directory and all children, recursively.

Specified by:

deleteDirectory in interface FileHandle

Throws:

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

emptyDirectory

public void emptyDirectory()
                    throws java.io.IOException

Description copied from interface: FileHandle

Deletes all children of this directory, recursively.

Specified by:

emptyDirectory in interface FileHandle

Throws:

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

emptyDirectory

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

Description copied from interface: FileHandle

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

Specified by:

emptyDirectory in interface FileHandle

Throws:

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

copyTo

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

Description copied from interface: FileHandle

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, FileHandle.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, FileHandle.mkdirs() is called on the destination and this directory is copied into it recursively.

Specified by:

copyTo in interface FileHandle

Throws:

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

moveTo

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

Description copied from interface: FileHandle

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

Specified by:

moveTo in interface FileHandle

Throws:

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

length

public long length()

Description copied from interface: FileHandle

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.

Specified by:

length in interface FileHandle

lastModified

public long lastModified()

Description copied from interface: FileHandle

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.

Specified by:

lastModified in interface FileHandle