|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.badlogic.gdx.files.FileHandle
public class FileHandle
Represents a file or directory on the filesystem, classpath, Android SD card, or Android assets directory. FileHandles are
created via a Files
instance.
Field Summary | |
---|---|
protected java.io.File |
file
|
protected Files.FileType |
type
|
Constructor Summary | |
---|---|
protected |
FileHandle()
|
|
FileHandle(java.io.File file)
Creates a new absolute FileHandle for the File . |
protected |
FileHandle(java.io.File file,
Files.FileType type)
|
|
FileHandle(java.lang.String fileName)
Creates a new absolute FileHandle for the file name. |
protected |
FileHandle(java.lang.String fileName,
Files.FileType type)
|
Method Summary | |
---|---|
FileHandle |
child(java.lang.String name)
Returns a handle to the child with the specified name. |
void |
copyTo(FileHandle dest)
Copies this file to the specified file, overwriting the file if it already exists. |
boolean |
delete()
Deletes this file or empty directory and returns success. |
boolean |
deleteDirectory()
Deletes this file or directory and all children, recursively. |
boolean |
exists()
Returns true if the file exists. |
java.lang.String |
extension()
|
boolean |
isDirectory()
Returns true if this file is a directory. |
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.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()
|
FileHandle |
parent()
|
java.lang.String |
path()
|
java.io.InputStream |
read()
Returns a stream for reading this file. |
byte[] |
readBytes()
Reads the entire file into a byte array. |
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. |
java.lang.String |
toString()
|
Files.FileType |
type()
|
java.io.OutputStream |
write(boolean append)
Returns a stream for writing to this file. |
java.io.Writer |
writer(boolean append)
Returns a writer for writing to this file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.io.File file
protected Files.FileType type
Constructor Detail |
---|
protected FileHandle()
public FileHandle(java.lang.String fileName)
Files
interface instead.
fileName
- the filename.public FileHandle(java.io.File file)
File
. Use this for tools on the desktop that don't need any of the
backends. Do not use this constructor in case you write something cross-platform. Use the Files
interface instead.
file
- the file.protected FileHandle(java.lang.String fileName, Files.FileType type)
protected FileHandle(java.io.File file, Files.FileType type)
Method Detail |
---|
public java.lang.String path()
public java.lang.String name()
public java.lang.String extension()
public java.lang.String nameWithoutExtension()
public Files.FileType type()
public java.io.InputStream read()
public java.lang.String readString()
public java.lang.String readString(java.lang.String charset)
public byte[] readBytes()
public java.io.OutputStream write(boolean append)
append
- If false, this file will be overwritten if it exists, otherwise it will be appended.public java.io.Writer writer(boolean append)
append
- If false, this file will be overwritten if it exists, otherwise it will be appended.public FileHandle[] list()
public FileHandle[] list(java.lang.String suffix)
public boolean isDirectory()
public FileHandle child(java.lang.String name)
public FileHandle parent()
public void mkdirs()
public boolean exists()
public boolean delete()
public boolean deleteDirectory()
public void copyTo(FileHandle dest)
public void moveTo(FileHandle dest)
public long length()
public java.lang.String toString()
toString
in class java.lang.Object
|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |