CharSequenceReader.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  7. <title>CharSequenceReader (Apache Commons IO 2.6 API)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="CharSequenceReader (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/CharSequenceReader.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../../org/apache/commons/io/input/CharSequenceInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/apache/commons/io/input/ClassLoaderObjectInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/apache/commons/io/input/CharSequenceReader.html" target="_top">Frames</a></li>
  57. <li><a href="CharSequenceReader.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#fields.inherited.from.class.java.io.Reader">Field</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io.input</div>
  96. <h2 title="Class CharSequenceReader" class="title">Class CharSequenceReader</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">java.io.Reader</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.apache.commons.io.input.CharSequenceReader</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Readable.html?is-external=true" title="class or interface in java.lang">Readable</a></dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <span class="typeNameLabel">CharSequenceReader</span>
  122. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>
  123. implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
  124. <div class="block"><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> implementation that can read from String, StringBuffer,
  125. StringBuilder or CharBuffer.
  126. <p>
  127. <strong>Note:</strong> Supports <a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#mark-int-"><code>mark(int)</code></a> and <a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#reset--"><code>reset()</code></a>.</div>
  128. <dl>
  129. <dt><span class="simpleTagLabel">Since:</span></dt>
  130. <dd>1.4</dd>
  131. <dt><span class="seeLabel">See Also:</span></dt>
  132. <dd><a href="../../../../../serialized-form.html#org.apache.commons.io.input.CharSequenceReader">Serialized Form</a></dd>
  133. </dl>
  134. </li>
  135. </ul>
  136. </div>
  137. <div class="summary">
  138. <ul class="blockList">
  139. <li class="blockList">
  140. <!-- =========== FIELD SUMMARY =========== -->
  141. <ul class="blockList">
  142. <li class="blockList"><a name="field.summary">
  143. <!-- -->
  144. </a>
  145. <h3>Field Summary</h3>
  146. <ul class="blockList">
  147. <li class="blockList"><a name="fields.inherited.from.class.java.io.Reader">
  148. <!-- -->
  149. </a>
  150. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></h3>
  151. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#lock" title="class or interface in java.io">lock</a></code></li>
  152. </ul>
  153. </li>
  154. </ul>
  155. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  156. <ul class="blockList">
  157. <li class="blockList"><a name="constructor.summary">
  158. <!-- -->
  159. </a>
  160. <h3>Constructor Summary</h3>
  161. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  162. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  163. <tr>
  164. <th class="colOne" scope="col">Constructor and Description</th>
  165. </tr>
  166. <tr class="altColor">
  167. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#CharSequenceReader-java.lang.CharSequence-">CharSequenceReader</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</a>&nbsp;charSequence)</code>
  168. <div class="block">Construct a new instance with the specified character sequence.</div>
  169. </td>
  170. </tr>
  171. </table>
  172. </li>
  173. </ul>
  174. <!-- ========== METHOD SUMMARY =========== -->
  175. <ul class="blockList">
  176. <li class="blockList"><a name="method.summary">
  177. <!-- -->
  178. </a>
  179. <h3>Method Summary</h3>
  180. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  181. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  182. <tr>
  183. <th class="colFirst" scope="col">Modifier and Type</th>
  184. <th class="colLast" scope="col">Method and Description</th>
  185. </tr>
  186. <tr id="i0" class="altColor">
  187. <td class="colFirst"><code>void</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#close--">close</a></span>()</code>
  189. <div class="block">Close resets the file back to the start and removes any marked position.</div>
  190. </td>
  191. </tr>
  192. <tr id="i1" class="rowColor">
  193. <td class="colFirst"><code>void</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#mark-int-">mark</a></span>(int&nbsp;readAheadLimit)</code>
  195. <div class="block">Mark the current position.</div>
  196. </td>
  197. </tr>
  198. <tr id="i2" class="altColor">
  199. <td class="colFirst"><code>boolean</code></td>
  200. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#markSupported--">markSupported</a></span>()</code>
  201. <div class="block">Mark is supported (returns true).</div>
  202. </td>
  203. </tr>
  204. <tr id="i3" class="rowColor">
  205. <td class="colFirst"><code>int</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#read--">read</a></span>()</code>
  207. <div class="block">Read a single character.</div>
  208. </td>
  209. </tr>
  210. <tr id="i4" class="altColor">
  211. <td class="colFirst"><code>int</code></td>
  212. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#read-char:A-int-int-">read</a></span>(char[]&nbsp;array,
  213. int&nbsp;offset,
  214. int&nbsp;length)</code>
  215. <div class="block">Read the specified number of characters into the array.</div>
  216. </td>
  217. </tr>
  218. <tr id="i5" class="rowColor">
  219. <td class="colFirst"><code>void</code></td>
  220. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#reset--">reset</a></span>()</code>
  221. <div class="block">Reset the reader to the last marked position (or the beginning if
  222. mark has not been called).</div>
  223. </td>
  224. </tr>
  225. <tr id="i6" class="altColor">
  226. <td class="colFirst"><code>long</code></td>
  227. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#skip-long-">skip</a></span>(long&nbsp;n)</code>
  228. <div class="block">Skip the specified number of characters.</div>
  229. </td>
  230. </tr>
  231. <tr id="i7" class="rowColor">
  232. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html#toString--">toString</a></span>()</code>
  234. <div class="block">Return a String representation of the underlying
  235. character sequence.</div>
  236. </td>
  237. </tr>
  238. </table>
  239. <ul class="blockList">
  240. <li class="blockList"><a name="methods.inherited.from.class.java.io.Reader">
  241. <!-- -->
  242. </a>
  243. <h3>Methods inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></h3>
  244. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#read-char:A-" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#read-java.nio.CharBuffer-" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#ready--" title="class or interface in java.io">ready</a></code></li>
  245. </ul>
  246. <ul class="blockList">
  247. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  248. <!-- -->
  249. </a>
  250. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  251. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  252. </ul>
  253. </li>
  254. </ul>
  255. </li>
  256. </ul>
  257. </div>
  258. <div class="details">
  259. <ul class="blockList">
  260. <li class="blockList">
  261. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  262. <ul class="blockList">
  263. <li class="blockList"><a name="constructor.detail">
  264. <!-- -->
  265. </a>
  266. <h3>Constructor Detail</h3>
  267. <a name="CharSequenceReader-java.lang.CharSequence-">
  268. <!-- -->
  269. </a>
  270. <ul class="blockListLast">
  271. <li class="blockList">
  272. <h4>CharSequenceReader</h4>
  273. <pre>public&nbsp;CharSequenceReader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</a>&nbsp;charSequence)</pre>
  274. <div class="block">Construct a new instance with the specified character sequence.</div>
  275. <dl>
  276. <dt><span class="paramLabel">Parameters:</span></dt>
  277. <dd><code>charSequence</code> - The character sequence, may be <code>null</code></dd>
  278. </dl>
  279. </li>
  280. </ul>
  281. </li>
  282. </ul>
  283. <!-- ============ METHOD DETAIL ========== -->
  284. <ul class="blockList">
  285. <li class="blockList"><a name="method.detail">
  286. <!-- -->
  287. </a>
  288. <h3>Method Detail</h3>
  289. <a name="close--">
  290. <!-- -->
  291. </a>
  292. <ul class="blockList">
  293. <li class="blockList">
  294. <h4>close</h4>
  295. <pre>public&nbsp;void&nbsp;close()</pre>
  296. <div class="block">Close resets the file back to the start and removes any marked position.</div>
  297. <dl>
  298. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  299. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  300. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  301. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  302. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  303. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  304. </dl>
  305. </li>
  306. </ul>
  307. <a name="mark-int-">
  308. <!-- -->
  309. </a>
  310. <ul class="blockList">
  311. <li class="blockList">
  312. <h4>mark</h4>
  313. <pre>public&nbsp;void&nbsp;mark(int&nbsp;readAheadLimit)</pre>
  314. <div class="block">Mark the current position.</div>
  315. <dl>
  316. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  317. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#mark-int-" title="class or interface in java.io">mark</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  318. <dt><span class="paramLabel">Parameters:</span></dt>
  319. <dd><code>readAheadLimit</code> - ignored</dd>
  320. </dl>
  321. </li>
  322. </ul>
  323. <a name="markSupported--">
  324. <!-- -->
  325. </a>
  326. <ul class="blockList">
  327. <li class="blockList">
  328. <h4>markSupported</h4>
  329. <pre>public&nbsp;boolean&nbsp;markSupported()</pre>
  330. <div class="block">Mark is supported (returns true).</div>
  331. <dl>
  332. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  333. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#markSupported--" title="class or interface in java.io">markSupported</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  334. <dt><span class="returnLabel">Returns:</span></dt>
  335. <dd><code>true</code></dd>
  336. </dl>
  337. </li>
  338. </ul>
  339. <a name="read--">
  340. <!-- -->
  341. </a>
  342. <ul class="blockList">
  343. <li class="blockList">
  344. <h4>read</h4>
  345. <pre>public&nbsp;int&nbsp;read()</pre>
  346. <div class="block">Read a single character.</div>
  347. <dl>
  348. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  349. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#read--" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  350. <dt><span class="returnLabel">Returns:</span></dt>
  351. <dd>the next character from the character sequence
  352. or -1 if the end has been reached.</dd>
  353. </dl>
  354. </li>
  355. </ul>
  356. <a name="read-char:A-int-int-">
  357. <!-- -->
  358. </a>
  359. <ul class="blockList">
  360. <li class="blockList">
  361. <h4>read</h4>
  362. <pre>public&nbsp;int&nbsp;read(char[]&nbsp;array,
  363. int&nbsp;offset,
  364. int&nbsp;length)</pre>
  365. <div class="block">Read the specified number of characters into the array.</div>
  366. <dl>
  367. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  368. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#read-char:A-int-int-" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  369. <dt><span class="paramLabel">Parameters:</span></dt>
  370. <dd><code>array</code> - The array to store the characters in</dd>
  371. <dd><code>offset</code> - The starting position in the array to store</dd>
  372. <dd><code>length</code> - The maximum number of characters to read</dd>
  373. <dt><span class="returnLabel">Returns:</span></dt>
  374. <dd>The number of characters read or -1 if there are
  375. no more</dd>
  376. </dl>
  377. </li>
  378. </ul>
  379. <a name="reset--">
  380. <!-- -->
  381. </a>
  382. <ul class="blockList">
  383. <li class="blockList">
  384. <h4>reset</h4>
  385. <pre>public&nbsp;void&nbsp;reset()</pre>
  386. <div class="block">Reset the reader to the last marked position (or the beginning if
  387. mark has not been called).</div>
  388. <dl>
  389. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  390. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#reset--" title="class or interface in java.io">reset</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  391. </dl>
  392. </li>
  393. </ul>
  394. <a name="skip-long-">
  395. <!-- -->
  396. </a>
  397. <ul class="blockList">
  398. <li class="blockList">
  399. <h4>skip</h4>
  400. <pre>public&nbsp;long&nbsp;skip(long&nbsp;n)</pre>
  401. <div class="block">Skip the specified number of characters.</div>
  402. <dl>
  403. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  404. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#skip-long-" title="class or interface in java.io">skip</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  405. <dt><span class="paramLabel">Parameters:</span></dt>
  406. <dd><code>n</code> - The number of characters to skip</dd>
  407. <dt><span class="returnLabel">Returns:</span></dt>
  408. <dd>The actual number of characters skipped</dd>
  409. </dl>
  410. </li>
  411. </ul>
  412. <a name="toString--">
  413. <!-- -->
  414. </a>
  415. <ul class="blockListLast">
  416. <li class="blockList">
  417. <h4>toString</h4>
  418. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
  419. <div class="block">Return a String representation of the underlying
  420. character sequence.</div>
  421. <dl>
  422. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  423. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
  424. <dt><span class="returnLabel">Returns:</span></dt>
  425. <dd>The contents of the character sequence</dd>
  426. </dl>
  427. </li>
  428. </ul>
  429. </li>
  430. </ul>
  431. </li>
  432. </ul>
  433. </div>
  434. </div>
  435. <!-- ========= END OF CLASS DATA ========= -->
  436. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  437. <div class="bottomNav"><a name="navbar.bottom">
  438. <!-- -->
  439. </a>
  440. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  441. <a name="navbar.bottom.firstrow">
  442. <!-- -->
  443. </a>
  444. <ul class="navList" title="Navigation">
  445. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  446. <li><a href="package-summary.html">Package</a></li>
  447. <li class="navBarCell1Rev">Class</li>
  448. <li><a href="class-use/CharSequenceReader.html">Use</a></li>
  449. <li><a href="package-tree.html">Tree</a></li>
  450. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  451. <li><a href="../../../../../index-all.html">Index</a></li>
  452. <li><a href="../../../../../help-doc.html">Help</a></li>
  453. </ul>
  454. </div>
  455. <div class="subNav">
  456. <ul class="navList">
  457. <li><a href="../../../../../org/apache/commons/io/input/CharSequenceInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  458. <li><a href="../../../../../org/apache/commons/io/input/ClassLoaderObjectInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  459. </ul>
  460. <ul class="navList">
  461. <li><a href="../../../../../index.html?org/apache/commons/io/input/CharSequenceReader.html" target="_top">Frames</a></li>
  462. <li><a href="CharSequenceReader.html" target="_top">No&nbsp;Frames</a></li>
  463. </ul>
  464. <ul class="navList" id="allclasses_navbar_bottom">
  465. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  466. </ul>
  467. <div>
  468. <script type="text/javascript"><!--
  469. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  470. if(window==top) {
  471. allClassesLink.style.display = "block";
  472. }
  473. else {
  474. allClassesLink.style.display = "none";
  475. }
  476. //-->
  477. </script>
  478. </div>
  479. <div>
  480. <ul class="subNavList">
  481. <li>Summary:&nbsp;</li>
  482. <li>Nested&nbsp;|&nbsp;</li>
  483. <li><a href="#fields.inherited.from.class.java.io.Reader">Field</a>&nbsp;|&nbsp;</li>
  484. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  485. <li><a href="#method.summary">Method</a></li>
  486. </ul>
  487. <ul class="subNavList">
  488. <li>Detail:&nbsp;</li>
  489. <li>Field&nbsp;|&nbsp;</li>
  490. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  491. <li><a href="#method.detail">Method</a></li>
  492. </ul>
  493. </div>
  494. <a name="skip.navbar.bottom">
  495. <!-- -->
  496. </a></div>
  497. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  498. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  499. </body>
  500. </html>