<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_26) on Sun Jan 27 20:37:04 CET 2013 -->
<TITLE>
Files (libgdx API)
</TITLE>
<META NAME="date" CONTENT="2013-01-27">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Files (libgdx API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package
</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class
</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Files.html"><FONT CLASS="NavBarFont1"><B>Use
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help
</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/badlogic/gdx/Audio.html" title="interface in com.badlogic.gdx"><B>PREV CLASS
</B></A>
<A HREF="../../../com/badlogic/gdx/Files.FileType.html" title="enum in com.badlogic.gdx"><B>NEXT CLASS
</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/badlogic/gdx/Files.html" target="_top"><B>FRAMES
</B></A>
<A HREF="Files.html" target="_top"><B>NO FRAMES
</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes
</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:
<A HREF="#nested_class_summary">NESTED
</A> |
FIELD
|
CONSTR
|
<A HREF="#method_summary">METHOD
</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:
FIELD
|
CONSTR
|
<A HREF="#method_detail">METHOD
</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.badlogic.gdx
</FONT>
<BR>
Interface Files
</H2>
<HR>
<DL>
<DT><PRE>public interface
<B>Files
</B></DL>
</PRE>
<P>
Provides standard access to the filesystem, classpath, Android SD card, and Android assets directory.
<P>
<P>
<DL>
<DT><B>Author:
</B></DT>
<DD>mzechner, Nathan Sweet
</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary
</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
class
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.FileType.html" title="enum in com.badlogic.gdx">Files.FileType
</A></B></CODE>
<BR>
Indicates how to resolve a path to a file.
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary
</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#absolute(java.lang.String)">absolute
</A></B>(java.lang.String
path)
</CODE>
<BR>
Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Absolute"><CODE>Files.FileType.Absolute
</CODE></A> file handle.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#classpath(java.lang.String)">classpath
</A></B>(java.lang.String
path)
</CODE>
<BR>
Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Classpath"><CODE>Files.FileType.Classpath
</CODE></A> file handle.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#external(java.lang.String)">external
</A></B>(java.lang.String
path)
</CODE>
<BR>
Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#External"><CODE>Files.FileType.External
</CODE></A> file handle.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#getExternalStoragePath()">getExternalStoragePath
</A></B>()
</CODE>
<BR>
Returns the external storage path directory.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#getFileHandle(java.lang.String, com.badlogic.gdx.Files.FileType)">getFileHandle
</A></B>(java.lang.String
path,
<A HREF="../../../com/badlogic/gdx/Files.FileType.html" title="enum in com.badlogic.gdx">Files.FileType
</A> type)
</CODE>
<BR>
Returns a handle representing a file or directory.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#getLocalStoragePath()">getLocalStoragePath
</A></B>()
</CODE>
<BR>
Returns the local storage path directory.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#internal(java.lang.String)">internal
</A></B>(java.lang.String
path)
</CODE>
<BR>
Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Internal"><CODE>Files.FileType.Internal
</CODE></A> file handle.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#isExternalStorageAvailable()">isExternalStorageAvailable
</A></B>()
</CODE>
<BR>
Returns true if the external storage is ready for file IO.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#isLocalStorageAvailable()">isLocalStorageAvailable
</A></B>()
</CODE>
<BR>
Returns true if the local storage is ready for file IO.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/badlogic/gdx/Files.html#local(java.lang.String)">local
</A></B>(java.lang.String
path)
</CODE>
<BR>
Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Local"><CODE>Files.FileType.Local
</CODE></A> file handle.
</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail
</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getFileHandle(java.lang.String, com.badlogic.gdx.Files.FileType)"><!-- --></A><H3>
getFileHandle
</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A> <B>getFileHandle
</B>(java.lang.String
path,
<A HREF="../../../com/badlogic/gdx/Files.FileType.html" title="enum in com.badlogic.gdx">Files.FileType
</A> type)
</PRE>
<DL>
<DD>Returns a handle representing a file or directory.
<P>
<DD><DL>
<DT><B>Parameters:
</B><DD><CODE>type
</CODE> - Determines how the path is resolved.
<DT><B>Throws:
</B>
<DD><CODE><A HREF="../../../com/badlogic/gdx/utils/GdxRuntimeException.html" title="class in com.badlogic.gdx.utils">GdxRuntimeException
</A></CODE> - if the type is classpath or internal and the file does not exist.
<DT><B>See Also:
</B><DD><A HREF="../../../com/badlogic/gdx/Files.FileType.html" title="enum in com.badlogic.gdx"><CODE>Files.FileType
</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="classpath(java.lang.String)"><!-- --></A><H3>
classpath
</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A> <B>classpath
</B>(java.lang.String
path)
</PRE>
<DL>
<DD>Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Classpath"><CODE>Files.FileType.Classpath
</CODE></A> file handle.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="internal(java.lang.String)"><!-- --></A><H3>
internal
</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A> <B>internal
</B>(java.lang.String
path)
</PRE>
<DL>
<DD>Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Internal"><CODE>Files.FileType.Internal
</CODE></A> file handle.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="external(java.lang.String)"><!-- --></A><H3>
external
</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A> <B>external
</B>(java.lang.String
path)
</PRE>
<DL>
<DD>Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#External"><CODE>Files.FileType.External
</CODE></A> file handle.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="absolute(java.lang.String)"><!-- --></A><H3>
absolute
</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A> <B>absolute
</B>(java.lang.String
path)
</PRE>
<DL>
<DD>Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Absolute"><CODE>Files.FileType.Absolute
</CODE></A> file handle.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="local(java.lang.String)"><!-- --></A><H3>
local
</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle
</A> <B>local
</B>(java.lang.String
path)
</PRE>
<DL>
<DD>Convenience method that returns a
<A HREF="../../../com/badlogic/gdx/Files.FileType.html#Local"><CODE>Files.FileType.Local
</CODE></A> file handle.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getExternalStoragePath()"><!-- --></A><H3>
getExternalStoragePath
</H3>
<PRE>
java.lang.String
<B>getExternalStoragePath
</B>()
</PRE>
<DL>
<DD>Returns the external storage path directory. This is the SD card on Android and the home directory of the current user on
the desktop.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isExternalStorageAvailable()"><!-- --></A><H3>
isExternalStorageAvailable
</H3>
<PRE>
boolean
<B>isExternalStorageAvailable
</B>()
</PRE>
<DL>
<DD>Returns true if the external storage is ready for file IO. Eg, on Android, the SD card is not available when mounted for use
with a PC.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLocalStoragePath()"><!-- --></A><H3>
getLocalStoragePath
</H3>
<PRE>
java.lang.String
<B>getLocalStoragePath
</B>()
</PRE>
<DL>
<DD>Returns the local storage path directory. This is the private files directory on Android and the directory of the jar on the
desktop.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isLocalStorageAvailable()"><!-- --></A><H3>
isLocalStorageAvailable
</H3>
<PRE>
boolean
<B>isLocalStorageAvailable
</B>()
</PRE>
<DL>
<DD>Returns true if the local storage is ready for file IO.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package
</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class
</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Files.html"><FONT CLASS="NavBarFont1"><B>Use
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index
</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help
</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
libgdx API
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/badlogic/gdx/Audio.html" title="interface in com.badlogic.gdx"><B>PREV CLASS
</B></A>
<A HREF="../../../com/badlogic/gdx/Files.FileType.html" title="enum in com.badlogic.gdx"><B>NEXT CLASS
</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/badlogic/gdx/Files.html" target="_top"><B>FRAMES
</B></A>
<A HREF="Files.html" target="_top"><B>NO FRAMES
</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes
</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:
<A HREF="#nested_class_summary">NESTED
</A> |
FIELD
|
CONSTR
|
<A HREF="#method_summary">METHOD
</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:
FIELD
|
CONSTR
|
<A HREF="#method_detail">METHOD
</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div style="font-size:9pt"><i>
Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</BODY>
</HTML>