Java Doc for UTF8StreamReader.java in  » Science » javolution-5.2 » javolution » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » javolution 5.2 » javolution.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.Reader
      javolution.io.UTF8StreamReader

UTF8StreamReader
final public class UTF8StreamReader extends Reader implements Reusable(Code)

This class represents a UTF-8 stream reader.

This reader supports surrogate char pairs (representing characters in the range [U+10000 .. U+10FFFF]). It can also be used to read characters unicodes (31 bits) directly (ref. UTF8StreamReader.read() ).

Each invocation of one of the read() methods may cause one or more bytes to be read from the underlying byte-input stream. To enable the efficient conversion of bytes to characters, more bytes may be read ahead from the underlying stream than are necessary to satisfy the current read operation.

Instances of this class can be reused for different input streams and can be part of a higher level component (e.g. parser) in order to avoid dynamic buffer allocation when the input source changes. Also wrapping using a java.io.BufferedReader is unnescessary as instances of this class embed their own data buffers.

Note: This reader is unsynchronized and does not test if the UTF-8 encoding is well-formed (e.g. UTF-8 sequences longer than necessary to encode a character).


author:
   Jean-Marie Dautelle
version:
   2.0, December 9, 2004
See Also:   UTF8StreamWriter



Constructor Summary
public  UTF8StreamReader()
     Creates a UTF-8 reader having a byte buffer of moderate capacity (2048).
public  UTF8StreamReader(int capacity)
     Creates a UTF-8 reader having a byte buffer of specified capacity.

Method Summary
public  voidclose()
     Closes and UTF8StreamReader.reset resets this reader for reuse.
public  intread()
     Reads a single character.
public  intread(char cbuf, int off, int len)
     Reads characters into a portion of an array.
public  voidread(Appendable dest)
     Reads characters into the specified appendable.
public  booleanready()
     Indicates if this stream is ready to be read.
public  voidreset()
    
public  UTF8StreamReadersetInput(InputStream inStream)
     Sets the input stream to use for reading until this reader is closed. For example:[code] Reader reader = new UTF8StreamReader().setInput(inStream); [/code] is equivalent but reads twice as fast as [code] Reader reader = new j2me.io.InputStreamReader(inStream, "UTF-8"); [/code]
Parameters:
  inStream - the input stream.
public  UTF8StreamReadersetInputStream(InputStream inStream)
    


Constructor Detail
UTF8StreamReader
public UTF8StreamReader()(Code)
Creates a UTF-8 reader having a byte buffer of moderate capacity (2048).



UTF8StreamReader
public UTF8StreamReader(int capacity)(Code)
Creates a UTF-8 reader having a byte buffer of specified capacity.
Parameters:
  capacity - the capacity of the byte buffer.




Method Detail
close
public void close() throws IOException(Code)
Closes and UTF8StreamReader.reset resets this reader for reuse.
throws:
  IOException - if an I/O error occurs.



read
public int read() throws IOException(Code)
Reads a single character. This method will block until a character is available, an I/O error occurs or the end of the stream is reached. the 31-bits Unicode of the character read, or -1 if the end ofthe stream has been reached.
throws:
  IOException - if an I/O error occurs.



read
public int read(char cbuf, int off, int len) throws IOException(Code)
Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs or the end of the stream is reached.

Note: Characters between U+10000 and U+10FFFF are represented by surrogate pairs (two char).


Parameters:
  cbuf - the destination buffer.
Parameters:
  off - the offset at which to start storing characters.
Parameters:
  len - the maximum number of characters to read the number of characters read, or -1 if the end of thestream has been reached
throws:
  IOException - if an I/O error occurs.



read
public void read(Appendable dest) throws IOException(Code)
Reads characters into the specified appendable. This method will block until the end of the stream is reached.
Parameters:
  dest - the destination buffer.
throws:
  IOException - if an I/O error occurs.



ready
public boolean ready() throws IOException(Code)
Indicates if this stream is ready to be read. true if the next read() is guaranteed not to blockfor input; false otherwise.
throws:
  IOException - if an I/O error occurs.



reset
public void reset()(Code)



setInput
public UTF8StreamReader setInput(InputStream inStream)(Code)
Sets the input stream to use for reading until this reader is closed. For example:[code] Reader reader = new UTF8StreamReader().setInput(inStream); [/code] is equivalent but reads twice as fast as [code] Reader reader = new j2me.io.InputStreamReader(inStream, "UTF-8"); [/code]
Parameters:
  inStream - the input stream. this UTF-8 reader.
throws:
  IllegalStateException - if this reader is being reused and it has not been UTF8StreamReader.close closed or UTF8StreamReader.reset reset.



setInputStream
public UTF8StreamReader setInputStream(InputStream inStream)(Code)
UTF8StreamReader.setInput(InputStream)



Fields inherited from java.io.Reader
protected Object lock(Code)(Java Doc)

Methods inherited from java.io.Reader
abstract public void close() throws IOException(Code)(Java Doc)
public void mark(int readAheadLimit) throws IOException(Code)(Java Doc)
public boolean markSupported()(Code)(Java Doc)
public int read(java.nio.CharBuffer target) throws IOException(Code)(Java Doc)
public int read() throws IOException(Code)(Java Doc)
public int read(char cbuf) throws IOException(Code)(Java Doc)
abstract public int read(char cbuf, int off, int len) throws IOException(Code)(Java Doc)
public boolean ready() throws IOException(Code)(Java Doc)
public void reset() throws IOException(Code)(Java Doc)
public long skip(long n) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.