libGDX jnigen library 2.5.1 · com.badlogic.gdx.jnigen.FileDescriptor

Modifier and Type	Class and Description
public static enum	FileDescriptor.FileType Indicates how to resolve a path to a file.

Modifier and Type	Field and Description
protected File	file
protected FileDescriptor.FileType	type

Access	Constructor and Description
protected	FileDescriptor()
public	FileDescriptor(String the filename. fileName) Creates a new absolute FileHandle for the file name.
public	FileDescriptor(File the file. file) Creates a new absolute FileHandle for the `File`.
protected	FileDescriptor(String fileName, FileDescriptor.FileType type)
protected	FileDescriptor(File file, FileDescriptor.FileType type)

Method Summary

Modifier and Type	Method and Description
public FileDescriptor	child(String name) Returns a handle to the child with the specified name.
private static void	copyDirectory(FileDescriptor sourceDir, FileDescriptor destDir)
private static void	copyFile(FileDescriptor source, FileDescriptor dest)
public void	copyTo(FileDescriptor dest) Copies this file or directory to the specified file or directory.
public boolean	delete() Deletes this file or empty directory and returns success.
public boolean	deleteDirectory() Deletes this file or directory and all children, recursively.
private static boolean	deleteDirectory(File file)
public boolean	exists() Returns true if the file exists.
public String	extension()
public File	file() Returns a java.io.File that represents this file handle.
public boolean	isDirectory() Returns true if this file is a directory.
public long	lastModified() Returns the last modified time in milliseconds for this file.
public 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.
public FileDescriptor[]	list() Returns the paths to the children of this directory.
public FileDescriptor[]	list(String suffix) Returns the paths to the children of this directory with the specified suffix.
public boolean	mkdirs()
public void	moveTo(FileDescriptor dest) Moves this file to the specified file, overwriting the file if it already exists.
public String	name()
public String	nameWithoutExtension()
public FileDescriptor	parent()
public String	path()
public InputStream	read() Returns a stream for reading this file as bytes.
public byte[]	readBytes() Reads the entire file into a byte array.
public int	Returns: the number of read bytes readBytes(byte[] the array to load the file into bytes, int the offset to start writing bytes offset, int the number of bytes to read, see `length()` size) Reads the entire file into the byte array.
public Reader	reader() Returns a reader for reading this file as characters.
public Reader	reader(String charset) Returns a reader for reading this file as characters.
public BufferedReader	reader(int bufferSize) Returns a buffered reader for reading this file as characters.
public BufferedReader	reader(int bufferSize, String charset) Returns a buffered reader for reading this file as characters.
public String	readString() Reads the entire file into a string using the platform's default charset.
public String	readString(String charset) Reads the entire file into a string using the specified charset.
public static FileDescriptor	tempDirectory(String prefix)
public static FileDescriptor	tempFile(String prefix)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public FileDescriptor.FileType	type()
public OutputStream	write(boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append) Returns a stream for writing to this file.
public void	write(InputStream input, boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append) Reads the remaining bytes from the specified stream and writes them to this file.
public void	writeBytes(byte[] bytes, boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append) Writes the specified bytes to the file.
public Writer	writer(boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append) Returns a writer for writing to this file using the default charset.
public Writer	writer(boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append, String May be null to use the default charset. charset) Returns a writer for writing to this file.
public void	writeString(String string, boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append) Writes the specified string to the file using the default charset.
public void	writeString(String string, boolean If false, this file will be overwritten if it exists, otherwise it will be appended. append, String May be null to use the default charset. charset) Writes the specified string to the file as UTF-8.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

file	back to summary
protected File file

type	back to summary
protected FileDescriptor.FileType type

FileDescriptor	back to summary
protected FileDescriptor()

FileDescriptor	back to summary
public FileDescriptor(String fileName) Creates a new absolute FileHandle for the file name. 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. Parameters fileName:String the filename.

FileDescriptor	back to summary
public FileDescriptor(File file) Creates a new absolute FileHandle for the `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. Parameters file:File the file.

FileDescriptor	back to summary
protected FileDescriptor(String fileName, FileDescriptor.FileType type)

FileDescriptor	back to summary
protected FileDescriptor(File file, FileDescriptor.FileType type)

Method Detail

child back to summary

child	back to summary
public FileDescriptor child(String name) Returns a handle to the child with the specified name. Exceptions RuntimeException: if this file handle is a `FileType#Classpath` or FileType#Internal and the child doesn't exist.

public FileDescriptor child(String name)

Returns a handle to the child with the specified name.

Exceptions

RuntimeException:: if this file handle is a FileType#Classpath or FileType#Internal and the child doesn't exist.

copyDirectory	back to summary
private static void copyDirectory(FileDescriptor sourceDir, FileDescriptor destDir)

copyFile	back to summary
private static void copyFile(FileDescriptor source, FileDescriptor dest)

copyTo back to summary

copyTo	back to summary
public void copyTo(FileDescriptor dest) 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, RuntimeException is thrown, or 2) if the destination is a directory, this directory is copied recursively into it as a subdirectory, overwriting existing files, or 3) if the destination doesn't exist, `mkdirs()` is called on the destination and this directory is copied recursively into it as a subdirectory. Exceptions RuntimeException: if the destination file handle is a `FileType#Classpath` or FileType#Internal file, or copying failed.

public void copyTo(FileDescriptor dest)

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, RuntimeException is thrown, or 2) if the destination is a directory, this directory is copied recursively into it as a subdirectory, overwriting existing files, or 3) if the destination doesn't exist, mkdirs() is called on the destination and this directory is copied recursively into it as a subdirectory.

Exceptions

RuntimeException:: if the destination file handle is a FileType#Classpath or FileType#Internal file, or copying failed.

delete back to summary

delete	back to summary
public boolean delete() Deletes this file or empty directory and returns success. Will not delete a directory that has children. Exceptions RuntimeException: if this file handle is a `FileType#Classpath` or FileType#Internal file.

public boolean delete()

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

Exceptions

RuntimeException:: if this file handle is a FileType#Classpath or FileType#Internal file.

deleteDirectory back to summary

deleteDirectory	back to summary
public boolean deleteDirectory() Deletes this file or directory and all children, recursively. Exceptions RuntimeException: if this file handle is a `FileType#Classpath` or FileType#Internal file.

public boolean deleteDirectory()

Deletes this file or directory and all children, recursively.

Exceptions

RuntimeException:: if this file handle is a FileType#Classpath or FileType#Internal file.

deleteDirectory	back to summary
private static boolean deleteDirectory(File file)

exists	back to summary
public boolean exists() Returns true if the file exists. On Android, a `FileType#Classpath` or FileType#Internal handle to a directory will always return false.

extension	back to summary
public String extension()

file	back to summary
public File file() Returns a java.io.File that represents this file handle. Note the returned file will only be usable for `FileType#Absolute` and FileType#External file handles.

isDirectory	back to summary
public 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.

lastModified	back to summary
public 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#Classpath` files. On Android, zero is returned for FileType#Internal files. On the desktop, zero is returned for FileType#Internal files on the classpath.

length	back to summary
public 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.

list back to summary

list	back to summary
public FileDescriptor[] list() 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. Exceptions RuntimeException: if this file is an `FileType#Classpath` file.

public FileDescriptor[] list()

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.

Exceptions

RuntimeException:: if this file is an FileType#Classpath file.

list back to summary

list	back to summary
public FileDescriptor[] list(String suffix) 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. Exceptions RuntimeException: if this file is an `FileType#Classpath` file.

public FileDescriptor[] list(String suffix)

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.

Exceptions

RuntimeException:: if this file is an FileType#Classpath file.

mkdirs	back to summary
public boolean mkdirs() Exceptions RuntimeException: if this file handle is a `FileType#Classpath` or FileType#Internal file.

moveTo back to summary

moveTo	back to summary
public void moveTo(FileDescriptor dest) Moves this file to the specified file, overwriting the file if it already exists. Exceptions RuntimeException: if the source or destination file handle is a `FileType#Classpath` or FileType#Internal file.

public void moveTo(FileDescriptor dest)

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

Exceptions

RuntimeException:: if the source or destination file handle is a FileType#Classpath or FileType#Internal file.

name	back to summary
public String name()

nameWithoutExtension	back to summary
public String nameWithoutExtension()

parent	back to summary
public FileDescriptor parent()

path	back to summary
public String path()

read	back to summary
public InputStream read() Returns a stream for reading this file as bytes. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

read

back to summary

public InputStream read()

Returns a stream for reading this file as bytes.

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

readBytes	back to summary
public byte[] readBytes() Reads the entire file into a byte array. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

readBytes

back to summary

public byte[] readBytes()

Reads the entire file into a byte array.

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

readBytes back to summary

readBytes	back to summary
public int readBytes(byte[] bytes, int offset, int size) Reads the entire file into the byte array. The byte array must be big enough to hold the file's data. Parameters bytes:byte[] the array to load the file into offset:int the offset to start writing bytes size:int the number of bytes to read, see `length()` Returns:int the number of read bytes

public int readBytes(byte[] bytes, int offset, int size)

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

Parameters

bytes:byte[]: the array to load the file into
offset:int: the offset to start writing bytes
size:int: the number of bytes to read, see length()

Returns:int

the number of read bytes

reader	back to summary
public Reader reader() Returns a reader for reading this file as characters. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

reader

back to summary

public Reader reader()

Returns a reader for reading this file as characters.

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

reader	back to summary
public Reader reader(String charset) Returns a reader for reading this file as characters. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

reader

back to summary

public Reader reader(String charset)

Returns a reader for reading this file as characters.

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

reader	back to summary
public BufferedReader reader(int bufferSize) Returns a buffered reader for reading this file as characters. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

reader

back to summary

public BufferedReader reader(int bufferSize)

Returns a buffered reader for reading this file as characters.

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

reader	back to summary
public BufferedReader reader(int bufferSize, String charset) Returns a buffered reader for reading this file as characters. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

reader

back to summary

public BufferedReader reader(int bufferSize, String charset)

Returns a buffered reader for reading this file as characters.

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

readString	back to summary
public String readString() Reads the entire file into a string using the platform's default charset. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

readString

back to summary

public String readString()

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

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

readString	back to summary
public String readString(String charset) Reads the entire file into a string using the specified charset. Exceptions RuntimeException: if the file handle represents a directory, doesn't exist, or could not be read.

readString

back to summary

public String readString(String charset)

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

Exceptions

RuntimeException:: if the file handle represents a directory, doesn't exist, or could not be read.

tempDirectory	back to summary
public static FileDescriptor tempDirectory(String prefix)

tempFile	back to summary
public static FileDescriptor tempFile(String prefix)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

type	back to summary
public FileDescriptor.FileType type()

write back to summary

write	back to summary
public OutputStream write(boolean append) Returns a stream for writing to this file. Parent directories will be created if necessary. Parameters append:boolean If false, this file will be overwritten if it exists, otherwise it will be appended. Exceptions RuntimeException: if this file handle represents a directory, if it is a `FileType#Classpath` or FileType#Internal file, or if it could not be written.

public OutputStream write(boolean append)

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

Parameters

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

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

write back to summary

write	back to summary
public void write(InputStream input, boolean append) 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:boolean If false, this file will be overwritten if it exists, otherwise it will be appended. Exceptions RuntimeException: if this file handle represents a directory, if it is a `FileType#Classpath` or FileType#Internal file, or if it could not be written.

public void write(InputStream input, boolean append)

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:boolean: If false, this file will be overwritten if it exists, otherwise it will be appended.

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

writeBytes back to summary

writeBytes	back to summary
public void writeBytes(byte[] bytes, boolean append) Writes the specified bytes to the file. Parent directories will be created if necessary. Parameters append:boolean If false, this file will be overwritten if it exists, otherwise it will be appended. Exceptions RuntimeException: if this file handle represents a directory, if it is a `FileType#Classpath` or FileType#Internal file, or if it could not be written.

public void writeBytes(byte[] bytes, boolean append)

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

Parameters

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

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

writer back to summary

writer	back to summary
public Writer writer(boolean append) Returns a writer for writing to this file using the default charset. Parent directories will be created if necessary. Parameters append:boolean If false, this file will be overwritten if it exists, otherwise it will be appended. Exceptions RuntimeException: if this file handle represents a directory, if it is a `FileType#Classpath` or FileType#Internal file, or if it could not be written.

public Writer writer(boolean append)

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

Parameters

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

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

writer back to summary

writer	back to summary
public Writer writer(boolean append, String charset) Returns a writer for writing to this file. Parent directories will be created if necessary. Parameters append:boolean If false, this file will be overwritten if it exists, otherwise it will be appended. charset:String May be null to use the default charset. Exceptions RuntimeException: if this file handle represents a directory, if it is a `FileType#Classpath` or FileType#Internal file, or if it could not be written.

public Writer writer(boolean append, String charset)

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

Parameters

append:boolean: If false, this file will be overwritten if it exists, otherwise it will be appended.
charset:String: May be null to use the default charset.

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

writeString back to summary

public void writeString(String string, boolean append)

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

Parameters

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

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

writeString back to summary

public void writeString(String string, boolean append, String charset)

Writes the specified string to the file as UTF-8. Parent directories will be created if necessary.

Parameters

append:boolean: If false, this file will be overwritten if it exists, otherwise it will be appended.
charset:String: May be null to use the default charset.

Exceptions

RuntimeException:: if this file handle represents a directory, if it is a FileType#Classpath or FileType#Internal file, or if it could not be written.

Modifier and Type	Field and Description
public static final FileDescriptor.FileType	Absolute Path that is a fully qualified, absolute filesystem path.
public static final FileDescriptor.FileType	Classpath Path relative to the root of the classpath.

Modifier and Type	Method and Description
public static FileDescriptor.FileType	valueOf(String name)
public static FileDescriptor.FileType[]	values()

public Class FileDescriptor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FileDescriptor.FileType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail