Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1107 | chris | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 2 | <!-- NewPage --> |
||
| 3 | <html lang="en"> |
||
| 4 | <head> |
||
| 5 | <!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:46 CET 2013 --> |
||
| 6 | <title>FileHandleStream (libgdx API)</title> |
||
| 7 | <meta name="date" content="2013-11-03"> |
||
| 8 | <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
||
| 9 | </head> |
||
| 10 | <body> |
||
| 11 | <script type="text/javascript"><!-- |
||
| 12 | if (location.href.indexOf('is-external=true') == -1) { |
||
| 13 | parent.document.title="FileHandleStream (libgdx API)"; |
||
| 14 | } |
||
| 15 | //--> |
||
| 16 | </script> |
||
| 17 | <noscript> |
||
| 18 | <div>JavaScript is disabled on your browser.</div> |
||
| 19 | </noscript> |
||
| 20 | <!-- ========= START OF TOP NAVBAR ======= --> |
||
| 21 | <div class="topNav"><a name="navbar_top"> |
||
| 22 | <!-- --> |
||
| 23 | </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
||
| 24 | <!-- --> |
||
| 25 | </a> |
||
| 26 | <ul class="navList" title="Navigation"> |
||
| 27 | <li><a href="../../../../overview-summary.html">Overview</a></li> |
||
| 28 | <li><a href="package-summary.html">Package</a></li> |
||
| 29 | <li class="navBarCell1Rev">Class</li> |
||
| 30 | <li><a href="class-use/FileHandleStream.html">Use</a></li> |
||
| 31 | <li><a href="package-tree.html">Tree</a></li> |
||
| 32 | <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
||
| 33 | <li><a href="../../../../index-all.html">Index</a></li> |
||
| 34 | <li><a href="../../../../help-doc.html">Help</a></li> |
||
| 35 | </ul> |
||
| 36 | <div class="aboutLanguage"><em> |
||
| 37 | libgdx API |
||
| 38 | <style> |
||
| 39 | body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt } |
||
| 40 | pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif } |
||
| 41 | h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold } |
||
| 42 | .TableHeadingColor { background:#EEEEFF; } |
||
| 43 | a { text-decoration:none } |
||
| 44 | a:hover { text-decoration:underline } |
||
| 45 | a:link, a:visited { color:blue } |
||
| 46 | table { border:0px } |
||
| 47 | .TableRowColor td:first-child { border-left:1px solid black } |
||
| 48 | .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black } |
||
| 49 | hr { border:0px; border-bottom:1px solid #333366; } |
||
| 50 | </style> |
||
| 51 | </em></div> |
||
| 52 | </div> |
||
| 53 | <div class="subNav"> |
||
| 54 | <ul class="navList"> |
||
| 55 | <li><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files"><span class="strong">Prev Class</span></a></li> |
||
| 56 | <li>Next Class</li> |
||
| 57 | </ul> |
||
| 58 | <ul class="navList"> |
||
| 59 | <li><a href="../../../../index.html?com/badlogic/gdx/files/FileHandleStream.html" target="_top">Frames</a></li> |
||
| 60 | <li><a href="FileHandleStream.html" target="_top">No Frames</a></li> |
||
| 61 | </ul> |
||
| 62 | <ul class="navList" id="allclasses_navbar_top"> |
||
| 63 | <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
||
| 64 | </ul> |
||
| 65 | <div> |
||
| 66 | <script type="text/javascript"><!-- |
||
| 67 | allClassesLink = document.getElementById("allclasses_navbar_top"); |
||
| 68 | if(window==top) { |
||
| 69 | allClassesLink.style.display = "block"; |
||
| 70 | } |
||
| 71 | else { |
||
| 72 | allClassesLink.style.display = "none"; |
||
| 73 | } |
||
| 74 | //--> |
||
| 75 | </script> |
||
| 76 | </div> |
||
| 77 | <div> |
||
| 78 | <ul class="subNavList"> |
||
| 79 | <li>Summary: </li> |
||
| 80 | <li>Nested | </li> |
||
| 81 | <li><a href="#fields_inherited_from_class_com.badlogic.gdx.files.FileHandle">Field</a> | </li> |
||
| 82 | <li><a href="#constructor_summary">Constr</a> | </li> |
||
| 83 | <li><a href="#method_summary">Method</a></li> |
||
| 84 | </ul> |
||
| 85 | <ul class="subNavList"> |
||
| 86 | <li>Detail: </li> |
||
| 87 | <li>Field | </li> |
||
| 88 | <li><a href="#constructor_detail">Constr</a> | </li> |
||
| 89 | <li><a href="#method_detail">Method</a></li> |
||
| 90 | </ul> |
||
| 91 | </div> |
||
| 92 | <a name="skip-navbar_top"> |
||
| 93 | <!-- --> |
||
| 94 | </a></div> |
||
| 95 | <!-- ========= END OF TOP NAVBAR ========= --> |
||
| 96 | <!-- ======== START OF CLASS DATA ======== --> |
||
| 97 | <div class="header"> |
||
| 98 | <div class="subTitle">com.badlogic.gdx.files</div> |
||
| 99 | <h2 title="Class FileHandleStream" class="title">Class FileHandleStream</h2> |
||
| 100 | </div> |
||
| 101 | <div class="contentContainer"> |
||
| 102 | <ul class="inheritance"> |
||
| 103 | <li>java.lang.Object</li> |
||
| 104 | <li> |
||
| 105 | <ul class="inheritance"> |
||
| 106 | <li><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">com.badlogic.gdx.files.FileHandle</a></li> |
||
| 107 | <li> |
||
| 108 | <ul class="inheritance"> |
||
| 109 | <li>com.badlogic.gdx.files.FileHandleStream</li> |
||
| 110 | </ul> |
||
| 111 | </li> |
||
| 112 | </ul> |
||
| 113 | </li> |
||
| 114 | </ul> |
||
| 115 | <div class="description"> |
||
| 116 | <ul class="blockList"> |
||
| 117 | <li class="blockList"> |
||
| 118 | <hr> |
||
| 119 | <br> |
||
| 120 | <pre>public abstract class <span class="strong">FileHandleStream</span> |
||
| 121 | extends <a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></pre> |
||
| 122 | <div class="block">A FileHandle intended to be subclassed for the purpose of implementing <a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#read()"><code>read()</code></a> and/or <a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#write(boolean)"><code>write(boolean)</code></a>. Methods |
||
| 123 | that would manipulate the file instead throw UnsupportedOperationException.</div> |
||
| 124 | <dl><dt><span class="strong">Author:</span></dt> |
||
| 125 | <dd>Nathan Sweet</dd></dl> |
||
| 126 | </li> |
||
| 127 | </ul> |
||
| 128 | </div> |
||
| 129 | <div class="summary"> |
||
| 130 | <ul class="blockList"> |
||
| 131 | <li class="blockList"> |
||
| 132 | <!-- =========== FIELD SUMMARY =========== --> |
||
| 133 | <ul class="blockList"> |
||
| 134 | <li class="blockList"><a name="field_summary"> |
||
| 135 | <!-- --> |
||
| 136 | </a> |
||
| 137 | <h3>Field Summary</h3> |
||
| 138 | <ul class="blockList"> |
||
| 139 | <li class="blockList"><a name="fields_inherited_from_class_com.badlogic.gdx.files.FileHandle"> |
||
| 140 | <!-- --> |
||
| 141 | </a> |
||
| 142 | <h3>Fields inherited from class com.badlogic.gdx.files.<a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></h3> |
||
| 143 | <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#file">file</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#type">type</a></code></li> |
||
| 144 | </ul> |
||
| 145 | </li> |
||
| 146 | </ul> |
||
| 147 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
||
| 148 | <ul class="blockList"> |
||
| 149 | <li class="blockList"><a name="constructor_summary"> |
||
| 150 | <!-- --> |
||
| 151 | </a> |
||
| 152 | <h3>Constructor Summary</h3> |
||
| 153 | <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
||
| 154 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
||
| 155 | <tr> |
||
| 156 | <th class="colOne" scope="col">Constructor and Description</th> |
||
| 157 | </tr> |
||
| 158 | <tr class="altColor"> |
||
| 159 | <td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#FileHandleStream(java.lang.String)">FileHandleStream</a></strong>(java.lang.String path)</code> |
||
| 160 | <div class="block">Create an <a href="../../../../com/badlogic/gdx/Files.FileType.html#Absolute"><code>Files.FileType.Absolute</code></a> file at the given location.</div> |
||
| 161 | </td> |
||
| 162 | </tr> |
||
| 163 | </table> |
||
| 164 | </li> |
||
| 165 | </ul> |
||
| 166 | <!-- ========== METHOD SUMMARY =========== --> |
||
| 167 | <ul class="blockList"> |
||
| 168 | <li class="blockList"><a name="method_summary"> |
||
| 169 | <!-- --> |
||
| 170 | </a> |
||
| 171 | <h3>Method Summary</h3> |
||
| 172 | <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
||
| 173 | <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
||
| 174 | <tr> |
||
| 175 | <th class="colFirst" scope="col">Modifier and Type</th> |
||
| 176 | <th class="colLast" scope="col">Method and Description</th> |
||
| 177 | </tr> |
||
| 178 | <tr class="altColor"> |
||
| 179 | <td class="colFirst"><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></td> |
||
| 180 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#child(java.lang.String)">child</a></strong>(java.lang.String name)</code> |
||
| 181 | <div class="block">Returns a handle to the child with the specified name.</div> |
||
| 182 | </td> |
||
| 183 | </tr> |
||
| 184 | <tr class="rowColor"> |
||
| 185 | <td class="colFirst"><code>void</code></td> |
||
| 186 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#copyTo(com.badlogic.gdx.files.FileHandle)">copyTo</a></strong>(<a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> dest)</code> |
||
| 187 | <div class="block">Copies this file or directory to the specified file or directory.</div> |
||
| 188 | </td> |
||
| 189 | </tr> |
||
| 190 | <tr class="altColor"> |
||
| 191 | <td class="colFirst"><code>boolean</code></td> |
||
| 192 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#delete()">delete</a></strong>()</code> |
||
| 193 | <div class="block">Deletes this file or empty directory and returns success.</div> |
||
| 194 | </td> |
||
| 195 | </tr> |
||
| 196 | <tr class="rowColor"> |
||
| 197 | <td class="colFirst"><code>boolean</code></td> |
||
| 198 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#deleteDirectory()">deleteDirectory</a></strong>()</code> |
||
| 199 | <div class="block">Deletes this file or directory and all children, recursively.</div> |
||
| 200 | </td> |
||
| 201 | </tr> |
||
| 202 | <tr class="altColor"> |
||
| 203 | <td class="colFirst"><code>boolean</code></td> |
||
| 204 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#exists()">exists</a></strong>()</code> |
||
| 205 | <div class="block">Returns true if the file exists.</div> |
||
| 206 | </td> |
||
| 207 | </tr> |
||
| 208 | <tr class="rowColor"> |
||
| 209 | <td class="colFirst"><code>boolean</code></td> |
||
| 210 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#isDirectory()">isDirectory</a></strong>()</code> |
||
| 211 | <div class="block">Returns true if this file is a directory.</div> |
||
| 212 | </td> |
||
| 213 | </tr> |
||
| 214 | <tr class="altColor"> |
||
| 215 | <td class="colFirst"><code>long</code></td> |
||
| 216 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#length()">length</a></strong>()</code> |
||
| 217 | <div class="block">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 |
||
| 218 | determined.</div> |
||
| 219 | </td> |
||
| 220 | </tr> |
||
| 221 | <tr class="rowColor"> |
||
| 222 | <td class="colFirst"><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a>[]</code></td> |
||
| 223 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#list()">list</a></strong>()</code> |
||
| 224 | <div class="block">Returns the paths to the children of this directory.</div> |
||
| 225 | </td> |
||
| 226 | </tr> |
||
| 227 | <tr class="altColor"> |
||
| 228 | <td class="colFirst"><code>void</code></td> |
||
| 229 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#mkdirs()">mkdirs</a></strong>()</code> </td> |
||
| 230 | </tr> |
||
| 231 | <tr class="rowColor"> |
||
| 232 | <td class="colFirst"><code>void</code></td> |
||
| 233 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#moveTo(com.badlogic.gdx.files.FileHandle)">moveTo</a></strong>(<a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> dest)</code> |
||
| 234 | <div class="block">Moves this file to the specified file, overwriting the file if it already exists.</div> |
||
| 235 | </td> |
||
| 236 | </tr> |
||
| 237 | <tr class="altColor"> |
||
| 238 | <td class="colFirst"><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></td> |
||
| 239 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#parent()">parent</a></strong>()</code> </td> |
||
| 240 | </tr> |
||
| 241 | <tr class="rowColor"> |
||
| 242 | <td class="colFirst"><code>java.io.InputStream</code></td> |
||
| 243 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#read()">read</a></strong>()</code> |
||
| 244 | <div class="block">Returns a stream for reading this file as bytes.</div> |
||
| 245 | </td> |
||
| 246 | </tr> |
||
| 247 | <tr class="altColor"> |
||
| 248 | <td class="colFirst"><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></td> |
||
| 249 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#sibling(java.lang.String)">sibling</a></strong>(java.lang.String name)</code> |
||
| 250 | <div class="block">Returns a handle to the sibling with the specified name.</div> |
||
| 251 | </td> |
||
| 252 | </tr> |
||
| 253 | <tr class="rowColor"> |
||
| 254 | <td class="colFirst"><code>java.io.OutputStream</code></td> |
||
| 255 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/files/FileHandleStream.html#write(boolean)">write</a></strong>(boolean overwrite)</code> |
||
| 256 | <div class="block">Returns a stream for writing to this file.</div> |
||
| 257 | </td> |
||
| 258 | </tr> |
||
| 259 | </table> |
||
| 260 | <ul class="blockList"> |
||
| 261 | <li class="blockList"><a name="methods_inherited_from_class_com.badlogic.gdx.files.FileHandle"> |
||
| 262 | <!-- --> |
||
| 263 | </a> |
||
| 264 | <h3>Methods inherited from class com.badlogic.gdx.files.<a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></h3> |
||
| 265 | <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#emptyDirectory()">emptyDirectory</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#emptyDirectory(boolean)">emptyDirectory</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#extension()">extension</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#file()">file</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#hashCode()">hashCode</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#lastModified()">lastModified</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#list(java.lang.String)">list</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#name()">name</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#nameWithoutExtension()">nameWithoutExtension</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#path()">path</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#pathWithoutExtension()">pathWithoutExtension</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#read(int)">read</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#readBytes()">readBytes</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#readBytes(byte[], int, int)">readBytes</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#reader()">reader</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#reader(int)">reader</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#reader(int, java.lang.String)">reader</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#reader(java.lang.String)">reader</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#readString()">readString</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#readString(java.lang.String)">readString</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#tempDirectory(java.lang.String)">tempDirectory</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#tempFile(java.lang.String)">tempFile</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#toString()">toString</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#type()">type</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#write(java.io.InputStream, boolean)">write</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#writeBytes(byte[], boolean)">writeBytes</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#writeBytes(byte[], int, int, boolean)">writeBytes</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#writer(boolean)">writer</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#writer(boolean, java.lang.String)">writer</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#writeString(java.lang.String, boolean)">writeString</a>, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#writeString(java.lang.String, boolean, java.lang.String)">writeString</a></code></li> |
||
| 266 | </ul> |
||
| 267 | <ul class="blockList"> |
||
| 268 | <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
||
| 269 | <!-- --> |
||
| 270 | </a> |
||
| 271 | <h3>Methods inherited from class java.lang.Object</h3> |
||
| 272 | <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> |
||
| 273 | </ul> |
||
| 274 | </li> |
||
| 275 | </ul> |
||
| 276 | </li> |
||
| 277 | </ul> |
||
| 278 | </div> |
||
| 279 | <div class="details"> |
||
| 280 | <ul class="blockList"> |
||
| 281 | <li class="blockList"> |
||
| 282 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
||
| 283 | <ul class="blockList"> |
||
| 284 | <li class="blockList"><a name="constructor_detail"> |
||
| 285 | <!-- --> |
||
| 286 | </a> |
||
| 287 | <h3>Constructor Detail</h3> |
||
| 288 | <a name="FileHandleStream(java.lang.String)"> |
||
| 289 | <!-- --> |
||
| 290 | </a> |
||
| 291 | <ul class="blockListLast"> |
||
| 292 | <li class="blockList"> |
||
| 293 | <h4>FileHandleStream</h4> |
||
| 294 | <pre>public FileHandleStream(java.lang.String path)</pre> |
||
| 295 | <div class="block">Create an <a href="../../../../com/badlogic/gdx/Files.FileType.html#Absolute"><code>Files.FileType.Absolute</code></a> file at the given location.</div> |
||
| 296 | </li> |
||
| 297 | </ul> |
||
| 298 | </li> |
||
| 299 | </ul> |
||
| 300 | <!-- ============ METHOD DETAIL ========== --> |
||
| 301 | <ul class="blockList"> |
||
| 302 | <li class="blockList"><a name="method_detail"> |
||
| 303 | <!-- --> |
||
| 304 | </a> |
||
| 305 | <h3>Method Detail</h3> |
||
| 306 | <a name="isDirectory()"> |
||
| 307 | <!-- --> |
||
| 308 | </a> |
||
| 309 | <ul class="blockList"> |
||
| 310 | <li class="blockList"> |
||
| 311 | <h4>isDirectory</h4> |
||
| 312 | <pre>public boolean isDirectory()</pre> |
||
| 313 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#isDirectory()">FileHandle</a></code></strong></div> |
||
| 314 | <div class="block">Returns true if this file is a directory. Always returns false for classpath files. On Android, an <a href="../../../../com/badlogic/gdx/Files.FileType.html#Internal"><code>Files.FileType.Internal</code></a> |
||
| 315 | handle to an empty directory will return false. On the desktop, an <a href="../../../../com/badlogic/gdx/Files.FileType.html#Internal"><code>Files.FileType.Internal</code></a> handle to a directory on the |
||
| 316 | classpath will return false.</div> |
||
| 317 | <dl> |
||
| 318 | <dt><strong>Overrides:</strong></dt> |
||
| 319 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#isDirectory()">isDirectory</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 320 | </dl> |
||
| 321 | </li> |
||
| 322 | </ul> |
||
| 323 | <a name="length()"> |
||
| 324 | <!-- --> |
||
| 325 | </a> |
||
| 326 | <ul class="blockList"> |
||
| 327 | <li class="blockList"> |
||
| 328 | <h4>length</h4> |
||
| 329 | <pre>public long length()</pre> |
||
| 330 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#length()">FileHandle</a></code></strong></div> |
||
| 331 | <div class="block">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 |
||
| 332 | determined.</div> |
||
| 333 | <dl> |
||
| 334 | <dt><strong>Overrides:</strong></dt> |
||
| 335 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#length()">length</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 336 | </dl> |
||
| 337 | </li> |
||
| 338 | </ul> |
||
| 339 | <a name="exists()"> |
||
| 340 | <!-- --> |
||
| 341 | </a> |
||
| 342 | <ul class="blockList"> |
||
| 343 | <li class="blockList"> |
||
| 344 | <h4>exists</h4> |
||
| 345 | <pre>public boolean exists()</pre> |
||
| 346 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#exists()">FileHandle</a></code></strong></div> |
||
| 347 | <div class="block">Returns true if the file exists. On Android, a <a href="../../../../com/badlogic/gdx/Files.FileType.html#Classpath"><code>Files.FileType.Classpath</code></a> or <a href="../../../../com/badlogic/gdx/Files.FileType.html#Internal"><code>Files.FileType.Internal</code></a> handle to a directory |
||
| 348 | will always return false. Note that this can be very slow for internal files on Android!</div> |
||
| 349 | <dl> |
||
| 350 | <dt><strong>Overrides:</strong></dt> |
||
| 351 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#exists()">exists</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 352 | </dl> |
||
| 353 | </li> |
||
| 354 | </ul> |
||
| 355 | <a name="child(java.lang.String)"> |
||
| 356 | <!-- --> |
||
| 357 | </a> |
||
| 358 | <ul class="blockList"> |
||
| 359 | <li class="blockList"> |
||
| 360 | <h4>child</h4> |
||
| 361 | <pre>public <a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> child(java.lang.String name)</pre> |
||
| 362 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#child(java.lang.String)">FileHandle</a></code></strong></div> |
||
| 363 | <div class="block">Returns a handle to the child with the specified name.</div> |
||
| 364 | <dl> |
||
| 365 | <dt><strong>Overrides:</strong></dt> |
||
| 366 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#child(java.lang.String)">child</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 367 | </dl> |
||
| 368 | </li> |
||
| 369 | </ul> |
||
| 370 | <a name="sibling(java.lang.String)"> |
||
| 371 | <!-- --> |
||
| 372 | </a> |
||
| 373 | <ul class="blockList"> |
||
| 374 | <li class="blockList"> |
||
| 375 | <h4>sibling</h4> |
||
| 376 | <pre>public <a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> sibling(java.lang.String name)</pre> |
||
| 377 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#sibling(java.lang.String)">FileHandle</a></code></strong></div> |
||
| 378 | <div class="block">Returns a handle to the sibling with the specified name.</div> |
||
| 379 | <dl> |
||
| 380 | <dt><strong>Overrides:</strong></dt> |
||
| 381 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#sibling(java.lang.String)">sibling</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 382 | </dl> |
||
| 383 | </li> |
||
| 384 | </ul> |
||
| 385 | <a name="parent()"> |
||
| 386 | <!-- --> |
||
| 387 | </a> |
||
| 388 | <ul class="blockList"> |
||
| 389 | <li class="blockList"> |
||
| 390 | <h4>parent</h4> |
||
| 391 | <pre>public <a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> parent()</pre> |
||
| 392 | <dl> |
||
| 393 | <dt><strong>Overrides:</strong></dt> |
||
| 394 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#parent()">parent</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 395 | </dl> |
||
| 396 | </li> |
||
| 397 | </ul> |
||
| 398 | <a name="read()"> |
||
| 399 | <!-- --> |
||
| 400 | </a> |
||
| 401 | <ul class="blockList"> |
||
| 402 | <li class="blockList"> |
||
| 403 | <h4>read</h4> |
||
| 404 | <pre>public java.io.InputStream read()</pre> |
||
| 405 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#read()">FileHandle</a></code></strong></div> |
||
| 406 | <div class="block">Returns a stream for reading this file as bytes.</div> |
||
| 407 | <dl> |
||
| 408 | <dt><strong>Overrides:</strong></dt> |
||
| 409 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#read()">read</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 410 | </dl> |
||
| 411 | </li> |
||
| 412 | </ul> |
||
| 413 | <a name="write(boolean)"> |
||
| 414 | <!-- --> |
||
| 415 | </a> |
||
| 416 | <ul class="blockList"> |
||
| 417 | <li class="blockList"> |
||
| 418 | <h4>write</h4> |
||
| 419 | <pre>public java.io.OutputStream write(boolean overwrite)</pre> |
||
| 420 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#write(boolean)">FileHandle</a></code></strong></div> |
||
| 421 | <div class="block">Returns a stream for writing to this file. Parent directories will be created if necessary.</div> |
||
| 422 | <dl> |
||
| 423 | <dt><strong>Overrides:</strong></dt> |
||
| 424 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#write(boolean)">write</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 425 | <dt><span class="strong">Parameters:</span></dt><dd><code>overwrite</code> - If false, this file will be overwritten if it exists, otherwise it will be appended.</dd></dl> |
||
| 426 | </li> |
||
| 427 | </ul> |
||
| 428 | <a name="list()"> |
||
| 429 | <!-- --> |
||
| 430 | </a> |
||
| 431 | <ul class="blockList"> |
||
| 432 | <li class="blockList"> |
||
| 433 | <h4>list</h4> |
||
| 434 | <pre>public <a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a>[] list()</pre> |
||
| 435 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#list()">FileHandle</a></code></strong></div> |
||
| 436 | <div class="block">Returns the paths to the children of this directory. Returns an empty list if this file handle represents a file and not a |
||
| 437 | directory. On the desktop, an <a href="../../../../com/badlogic/gdx/Files.FileType.html#Internal"><code>Files.FileType.Internal</code></a> handle to a directory on the classpath will return a zero length |
||
| 438 | array.</div> |
||
| 439 | <dl> |
||
| 440 | <dt><strong>Overrides:</strong></dt> |
||
| 441 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#list()">list</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 442 | </dl> |
||
| 443 | </li> |
||
| 444 | </ul> |
||
| 445 | <a name="mkdirs()"> |
||
| 446 | <!-- --> |
||
| 447 | </a> |
||
| 448 | <ul class="blockList"> |
||
| 449 | <li class="blockList"> |
||
| 450 | <h4>mkdirs</h4> |
||
| 451 | <pre>public void mkdirs()</pre> |
||
| 452 | <dl> |
||
| 453 | <dt><strong>Overrides:</strong></dt> |
||
| 454 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#mkdirs()">mkdirs</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 455 | </dl> |
||
| 456 | </li> |
||
| 457 | </ul> |
||
| 458 | <a name="delete()"> |
||
| 459 | <!-- --> |
||
| 460 | </a> |
||
| 461 | <ul class="blockList"> |
||
| 462 | <li class="blockList"> |
||
| 463 | <h4>delete</h4> |
||
| 464 | <pre>public boolean delete()</pre> |
||
| 465 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#delete()">FileHandle</a></code></strong></div> |
||
| 466 | <div class="block">Deletes this file or empty directory and returns success. Will not delete a directory that has children.</div> |
||
| 467 | <dl> |
||
| 468 | <dt><strong>Overrides:</strong></dt> |
||
| 469 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#delete()">delete</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 470 | </dl> |
||
| 471 | </li> |
||
| 472 | </ul> |
||
| 473 | <a name="deleteDirectory()"> |
||
| 474 | <!-- --> |
||
| 475 | </a> |
||
| 476 | <ul class="blockList"> |
||
| 477 | <li class="blockList"> |
||
| 478 | <h4>deleteDirectory</h4> |
||
| 479 | <pre>public boolean deleteDirectory()</pre> |
||
| 480 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#deleteDirectory()">FileHandle</a></code></strong></div> |
||
| 481 | <div class="block">Deletes this file or directory and all children, recursively.</div> |
||
| 482 | <dl> |
||
| 483 | <dt><strong>Overrides:</strong></dt> |
||
| 484 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#deleteDirectory()">deleteDirectory</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 485 | </dl> |
||
| 486 | </li> |
||
| 487 | </ul> |
||
| 488 | <a name="copyTo(com.badlogic.gdx.files.FileHandle)"> |
||
| 489 | <!-- --> |
||
| 490 | </a> |
||
| 491 | <ul class="blockList"> |
||
| 492 | <li class="blockList"> |
||
| 493 | <h4>copyTo</h4> |
||
| 494 | <pre>public void copyTo(<a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> dest)</pre> |
||
| 495 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#copyTo(com.badlogic.gdx.files.FileHandle)">FileHandle</a></code></strong></div> |
||
| 496 | <div class="block">Copies this file or directory to the specified file or directory. If this handle is a file, then 1) if the destination is a |
||
| 497 | file, it is overwritten, or 2) if the destination is a directory, this file is copied into it, or 3) if the destination |
||
| 498 | doesn't exist, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#mkdirs()"><code>FileHandle.mkdirs()</code></a> is called on the destination's parent and this file is copied into it with a new name. If |
||
| 499 | this handle is a directory, then 1) if the destination is a file, GdxRuntimeException is thrown, or 2) if the destination is |
||
| 500 | a directory, this directory is copied into it recursively, overwriting existing files, or 3) if the destination doesn't |
||
| 501 | exist, <a href="../../../../com/badlogic/gdx/files/FileHandle.html#mkdirs()"><code>FileHandle.mkdirs()</code></a> is called on the destination and this directory is copied into it recursively.</div> |
||
| 502 | <dl> |
||
| 503 | <dt><strong>Overrides:</strong></dt> |
||
| 504 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#copyTo(com.badlogic.gdx.files.FileHandle)">copyTo</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 505 | </dl> |
||
| 506 | </li> |
||
| 507 | </ul> |
||
| 508 | <a name="moveTo(com.badlogic.gdx.files.FileHandle)"> |
||
| 509 | <!-- --> |
||
| 510 | </a> |
||
| 511 | <ul class="blockListLast"> |
||
| 512 | <li class="blockList"> |
||
| 513 | <h4>moveTo</h4> |
||
| 514 | <pre>public void moveTo(<a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a> dest)</pre> |
||
| 515 | <div class="block"><strong>Description copied from class: <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#moveTo(com.badlogic.gdx.files.FileHandle)">FileHandle</a></code></strong></div> |
||
| 516 | <div class="block">Moves this file to the specified file, overwriting the file if it already exists.</div> |
||
| 517 | <dl> |
||
| 518 | <dt><strong>Overrides:</strong></dt> |
||
| 519 | <dd><code><a href="../../../../com/badlogic/gdx/files/FileHandle.html#moveTo(com.badlogic.gdx.files.FileHandle)">moveTo</a></code> in class <code><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</a></code></dd> |
||
| 520 | </dl> |
||
| 521 | </li> |
||
| 522 | </ul> |
||
| 523 | </li> |
||
| 524 | </ul> |
||
| 525 | </li> |
||
| 526 | </ul> |
||
| 527 | </div> |
||
| 528 | </div> |
||
| 529 | <!-- ========= END OF CLASS DATA ========= --> |
||
| 530 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
||
| 531 | <div class="bottomNav"><a name="navbar_bottom"> |
||
| 532 | <!-- --> |
||
| 533 | </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
||
| 534 | <!-- --> |
||
| 535 | </a> |
||
| 536 | <ul class="navList" title="Navigation"> |
||
| 537 | <li><a href="../../../../overview-summary.html">Overview</a></li> |
||
| 538 | <li><a href="package-summary.html">Package</a></li> |
||
| 539 | <li class="navBarCell1Rev">Class</li> |
||
| 540 | <li><a href="class-use/FileHandleStream.html">Use</a></li> |
||
| 541 | <li><a href="package-tree.html">Tree</a></li> |
||
| 542 | <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
||
| 543 | <li><a href="../../../../index-all.html">Index</a></li> |
||
| 544 | <li><a href="../../../../help-doc.html">Help</a></li> |
||
| 545 | </ul> |
||
| 546 | <div class="aboutLanguage"><em>libgdx API</em></div> |
||
| 547 | </div> |
||
| 548 | <div class="subNav"> |
||
| 549 | <ul class="navList"> |
||
| 550 | <li><a href="../../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files"><span class="strong">Prev Class</span></a></li> |
||
| 551 | <li>Next Class</li> |
||
| 552 | </ul> |
||
| 553 | <ul class="navList"> |
||
| 554 | <li><a href="../../../../index.html?com/badlogic/gdx/files/FileHandleStream.html" target="_top">Frames</a></li> |
||
| 555 | <li><a href="FileHandleStream.html" target="_top">No Frames</a></li> |
||
| 556 | </ul> |
||
| 557 | <ul class="navList" id="allclasses_navbar_bottom"> |
||
| 558 | <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
||
| 559 | </ul> |
||
| 560 | <div> |
||
| 561 | <script type="text/javascript"><!-- |
||
| 562 | allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
||
| 563 | if(window==top) { |
||
| 564 | allClassesLink.style.display = "block"; |
||
| 565 | } |
||
| 566 | else { |
||
| 567 | allClassesLink.style.display = "none"; |
||
| 568 | } |
||
| 569 | //--> |
||
| 570 | </script> |
||
| 571 | </div> |
||
| 572 | <div> |
||
| 573 | <ul class="subNavList"> |
||
| 574 | <li>Summary: </li> |
||
| 575 | <li>Nested | </li> |
||
| 576 | <li><a href="#fields_inherited_from_class_com.badlogic.gdx.files.FileHandle">Field</a> | </li> |
||
| 577 | <li><a href="#constructor_summary">Constr</a> | </li> |
||
| 578 | <li><a href="#method_summary">Method</a></li> |
||
| 579 | </ul> |
||
| 580 | <ul class="subNavList"> |
||
| 581 | <li>Detail: </li> |
||
| 582 | <li>Field | </li> |
||
| 583 | <li><a href="#constructor_detail">Constr</a> | </li> |
||
| 584 | <li><a href="#method_detail">Method</a></li> |
||
| 585 | </ul> |
||
| 586 | </div> |
||
| 587 | <a name="skip-navbar_bottom"> |
||
| 588 | <!-- --> |
||
| 589 | </a></div> |
||
| 590 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
||
| 591 | <p class="legalCopy"><small> |
||
| 592 | <div style="font-size:9pt"><i> |
||
| 593 | Copyright © 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com) |
||
| 594 | </i></div> |
||
| 595 | </small></p> |
||
| 596 | </body> |
||
| 597 | </html> |