Java Doc for BufferedReader.java in  » Apache-Harmony-Java-SE » java-package » java » 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 » Apache Harmony Java SE » java package » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.Reader
      java.io.BufferedReader

All known Subclasses:   java.io.LineNumberReader,
BufferedReader
public class BufferedReader extends Reader (Code)
BufferedReader is a buffered character input reader. Buffering allows reading from character streams more efficiently. If the default size of the buffer is not practical, another size may be specified. Reading a character from a Reader class usually involves reading a character from its Stream or subsequent Reader. It is advisable to wrap a BufferedReader around those Readers whose read operations may have high latency. For example, the following code
 BufferedReader inReader = new BufferedReader(new FileReader("file.java"));
 
will buffer input for the file file.java.
See Also:   BufferedWriter
since:
   1.1



Constructor Summary
public  BufferedReader(Reader in)
     Constructs a new BufferedReader on the Reader in.
public  BufferedReader(Reader in, int size)
     Constructs a new BufferedReader on the Reader in.

Method Summary
public  voidclose()
     Close the Reader.
public  voidmark(int readlimit)
     Set a Mark position in this BufferedReader.
public  booleanmarkSupported()
     Answers a boolean indicating whether or not this Reader supports mark() and reset().
public  intread()
     Reads a single character from this reader and returns the result as an int.
public  intread(char[] buffer, int offset, int length)
     Reads at most length characters from this BufferedReader and stores them at offset in the character array buffer.
public  StringreadLine()
     Answers a String representing the next line of text available in this BufferedReader.
public  booleanready()
     Answers a boolean indicating whether or not this Reader is ready to be read without blocking.
public  voidreset()
     Reset this BufferedReader's position to the last mark() location.
public  longskip(long amount)
     Skips amount number of characters in this Reader. Subsequent read()'s will not return these characters unless reset() is used.


Constructor Detail
BufferedReader
public BufferedReader(Reader in)(Code)
Constructs a new BufferedReader on the Reader in. The default buffer size (8K) is allocated and all reads can now be filtered through this BufferedReader.
Parameters:
  in - the Reader to buffer reads on.



BufferedReader
public BufferedReader(Reader in, int size)(Code)
Constructs a new BufferedReader on the Reader in. The buffer size is specified by the parameter size and all reads can now be filtered through this BufferedReader.
Parameters:
  in - the Reader to buffer reads on.
Parameters:
  size - the size of buffer to allocate.
throws:
  IllegalArgumentException - if the size is <= 0




Method Detail
close
public void close() throws IOException(Code)
Close the Reader. This implementation closes the Reader being filtered and releases the buffer used by this reader. If this BufferedReader has already been closed, nothing is done.
throws:
  IOException - If an error occurs attempting to close this BufferedReader.



mark
public void mark(int readlimit) throws IOException(Code)
Set a Mark position in this BufferedReader. The parameter readLimit indicates how many characters can be read before a mark is invalidated. Sending reset() will reposition the reader back to the marked position provided readLimit has not been surpassed.
Parameters:
  readlimit - an int representing how many characters must be read beforeinvalidating the mark.
throws:
  IOException - If an error occurs attempting mark this BufferedReader.
throws:
  IllegalArgumentException - If readlimit is < 0



markSupported
public boolean markSupported()(Code)
Answers a boolean indicating whether or not this Reader supports mark() and reset(). This implementation answers true. true if mark() and reset() are supported,false otherwise



read
public int read() throws IOException(Code)
Reads a single character from this reader and returns the result as an int. The 2 higher-order characters are set to 0. If the end of reader was encountered then return -1. This implementation either returns a character from the buffer or if there are no characters available, fill the buffer then return a character or -1. the character read or -1 if end of reader.
throws:
  IOException - If the BufferedReader is already closed or some other IOerror occurs.



read
public int read(char[] buffer, int offset, int length) throws IOException(Code)
Reads at most length characters from this BufferedReader and stores them at offset in the character array buffer. Returns the number of characters actually read or -1 if the end of reader was encountered. If all the buffered characters have been used, a mark has not been set, and the requested number of characters is larger than this Readers buffer size, this implementation bypasses the buffer and simply places the results directly into buffer.
Parameters:
  buffer - character array to store the read characters
Parameters:
  offset - offset in buf to store the read characters
Parameters:
  length - maximum number of characters to read number of characters read or -1 if end of reader.
throws:
  IOException - If the BufferedReader is already closed or some other IOerror occurs.



readLine
public String readLine() throws IOException(Code)
Answers a String representing the next line of text available in this BufferedReader. A line is represented by 0 or more characters followed by '\n', '\r', '\r\n' or end of stream. The String does not include the newline sequence. In EBCDIC systems, a new line can also be represented by the '\u0085' (NEL) character. the contents of the line or null if no characters were readbefore end of stream.
throws:
  IOException - If the BufferedReader is already closed or some other IOerror occurs.



ready
public boolean ready() throws IOException(Code)
Answers a boolean indicating whether or not this Reader is ready to be read without blocking. If the result is true, the next read() will not block. If the result is false this Reader may or may not block when read() is sent. true if the receiver will not block whenread() is called, false if unknownor blocking will occur.
throws:
  IOException - If the BufferedReader is already closed or some other IOerror occurs.



reset
public void reset() throws IOException(Code)
Reset this BufferedReader's position to the last mark() location. Invocations of read()/skip() will occur from this new location. If this Reader was not marked, throw IOException.
throws:
  IOException - If a problem occurred, the receiver does not supportmark()/reset(), or no mark has been set.



skip
public long skip(long amount) throws IOException(Code)
Skips amount number of characters in this Reader. Subsequent read()'s will not return these characters unless reset() is used. Skipping characters may invalidate a mark if marklimit is surpassed.
Parameters:
  amount - the maximum number of characters to skip. the number of characters actually skipped.
throws:
  IOException - If the BufferedReader is already closed or some other IOerror occurs.
throws:
  IllegalArgumentException - If amount is negative



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 readLimit) throws IOException(Code)(Java Doc)
public boolean markSupported()(Code)(Java Doc)
public int read() throws IOException(Code)(Java Doc)
public int read(char buf) throws IOException(Code)(Java Doc)
abstract public int read(char buf, int offset, int count) throws IOException(Code)(Java Doc)
public int read(CharBuffer target) 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 count) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final public Class<? extends Object> getClass()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
final public void notify()(Code)(Java Doc)
final public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final public void wait(long millis, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait(long millis) 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.