Java Doc for LineNumberReader.java in  » 6.0-JDK-Core » io-nio » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
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
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

LineNumberReader
public class LineNumberReader extends BufferedReader (Code)
A buffered character-input stream that keeps track of line numbers. This class defines methods LineNumberReader.setLineNumber(int) and LineNumberReader.getLineNumber() for setting and getting the current line number respectively.

By default, line numbering begins at 0. This number increments at every line terminator as the data is read, and can be changed with a call to setLineNumber(int). Note however, that setLineNumber(int) does not actually change the current position in the stream; it only changes the value that will be returned by getLineNumber().

A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.
version:
   1.29, 07/05/05
author:
   Mark Reinhold
since:
   JDK1.1




Constructor Summary
public  LineNumberReader(Reader in)
     Create a new line-numbering reader, using the default input-buffer size.
public  LineNumberReader(Reader in, int sz)
     Create a new line-numbering reader, reading characters into a buffer of the given size.

Method Summary
public  intgetLineNumber()
     Get the current line number.
public  voidmark(int readAheadLimit)
     Mark the present position in the stream.
public  intread()
     Read a single character.
public  intread(char cbuf, int off, int len)
     Read characters into a portion of an array.
public  StringreadLine()
     Read a line of text.
public  voidreset()
     Reset the stream to the most recent mark.
public  voidsetLineNumber(int lineNumber)
     Set the current line number.
public  longskip(long n)
     Skip characters.


Constructor Detail
LineNumberReader
public LineNumberReader(Reader in)(Code)
Create a new line-numbering reader, using the default input-buffer size.
Parameters:
  in - A Reader object to provide the underlying stream



LineNumberReader
public LineNumberReader(Reader in, int sz)(Code)
Create a new line-numbering reader, reading characters into a buffer of the given size.
Parameters:
  in - A Reader object to provide the underlying stream
Parameters:
  sz - An int specifying the size of the buffer




Method Detail
getLineNumber
public int getLineNumber()(Code)
Get the current line number. The current line number
See Also:   LineNumberReader.setLineNumber



mark
public void mark(int readAheadLimit) throws IOException(Code)
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point, and will also reset the line number appropriately.
Parameters:
  readAheadLimit - Limit on the number of characters that may be read while stillpreserving the mark. After reading this many characters,attempting to reset the stream may fail.
throws:
  IOException - If an I/O error occurs



read
public int read() throws IOException(Code)
Read a single character. Line terminators are compressed into single newline ('\n') characters. Whenever a line terminator is read the current line number is incremented. The character read, or -1 if the end of the stream has beenreached
throws:
  IOException - If an I/O error occurs



read
public int read(char cbuf, int off, int len) throws IOException(Code)
Read characters into a portion of an array. Whenever a line terminator is read the current line number is incremented.
Parameters:
  cbuf - Destination buffer
Parameters:
  off - Offset at which to start storing characters
Parameters:
  len - Maximum number of characters to read The number of bytes read, or -1 if the end of the stream hasalready been reached
throws:
  IOException - If an I/O error occurs



readLine
public String readLine() throws IOException(Code)
Read a line of text. Whenever a line terminator is read the current line number is incremented. A String containing the contents of the line, not includingany line termination characters, or null if the end of the stream has been reached
throws:
  IOException - If an I/O error occurs



reset
public void reset() throws IOException(Code)
Reset the stream to the most recent mark.
throws:
  IOException - If the stream has not been marked, or if the mark has beeninvalidated



setLineNumber
public void setLineNumber(int lineNumber)(Code)
Set the current line number.
Parameters:
  lineNumber - An int specifying the line number
See Also:   LineNumberReader.getLineNumber



skip
public long skip(long n) throws IOException(Code)
Skip characters.
Parameters:
  n - The number of characters to skip The number of characters actually skipped
throws:
  IOException - If an I/O error occurs
throws:
  IllegalArgumentException - If n is negative



Methods inherited from java.io.BufferedReader
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() throws IOException(Code)(Java Doc)
public int read(char cbuf, int off, int len) throws IOException(Code)(Java Doc)
String readLine(boolean ignoreLF) throws IOException(Code)(Java Doc)
public String readLine() 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)

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.