/[classpath]/classpath/java/io/BufferedReader.java
ViewVC logotype

Diff of /classpath/java/io/BufferedReader.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.17 by mkoch, Sun Mar 23 10:53:29 2003 UTC revision 1.18 by arenn, Mon Apr 7 20:28:01 2003 UTC
# Line 1  Line 1 
1  /* BufferedReader.java  /* BufferedReader.java
2     Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.     Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
3         Free Software Foundation, Inc.
4    
5  This file is part of GNU Classpath.  This file is part of GNU Classpath.
6    
# Line 48  package java.io; Line 49  package java.io;
49   * underlying implementation to provide a possibly more efficient read   * underlying implementation to provide a possibly more efficient read
50   * mechanism.  It maintains the buffer and buffer state in instance   * mechanism.  It maintains the buffer and buffer state in instance
51   * variables that are available to subclasses.  The default buffer size   * variables that are available to subclasses.  The default buffer size
52   * of 512 chars can be overridden by the creator of the stream.   * of 8192 chars can be overridden by the creator of the stream.
53   * <p>   * <p>
54   * This class also implements mark/reset functionality.  It is capable   * This class also implements mark/reset functionality.  It is capable
55   * of remembering any number of input chars, to the limits of   * of remembering any number of input chars, to the limits of
# Line 89  public class BufferedReader extends Read Line 90  public class BufferedReader extends Read
90    
91    /**    /**
92      * Create a new <code>BufferedReader</code> that will read from the      * Create a new <code>BufferedReader</code> that will read from the
93      * specified subordinate stream with a default buffer size of 4096 chars.      * specified subordinate stream with a default buffer size of 8192 chars.
94      *      *
95      * @param in The subordinate stream to read from      * @param in The subordinate stream to read from
96      */      */
# Line 104  public class BufferedReader extends Read Line 105  public class BufferedReader extends Read
105     * caller.     * caller.
106     *     *
107     * @param in The subordinate stream to read from     * @param in The subordinate stream to read from
108     * @param bufsize The buffer size to use     * @param size The buffer size to use
109     */     */
110    public BufferedReader(Reader in, int size)    public BufferedReader(Reader in, int size)
111    {    {
# Line 114  public class BufferedReader extends Read Line 115  public class BufferedReader extends Read
115    }    }
116    
117    /**    /**
118     * This method closes the stream     * This method closes the underlying stream and frees any associated
119       * resources.
120     *     *
121     * @exception IOException If an error occurs     * @exception IOException If an error occurs
122     */     */
# Line 143  public class BufferedReader extends Read Line 145  public class BufferedReader extends Read
145    /**    /**
146     * Mark a position in the input to which the stream can be     * Mark a position in the input to which the stream can be
147     * "reset" by calling the <code>reset()</code> method.  The parameter     * "reset" by calling the <code>reset()</code> method.  The parameter
148     * <code>readlimit</code> is the number of chars that can be read from the     * <code>readLimit</code> is the number of chars that can be read from the
149     * stream after setting the mark before the mark becomes invalid.  For     * stream after setting the mark before the mark becomes invalid.  For
150     * example, if <code>mark()</code> is called with a read limit of 10, then     * example, if <code>mark()</code> is called with a read limit of 10, then
151     * when 11 chars of data are read from the stream before the     * when 11 chars of data are read from the stream before the
# Line 155  public class BufferedReader extends Read Line 157  public class BufferedReader extends Read
157     * not dependent on the subordinate stream supporting mark/reset     * not dependent on the subordinate stream supporting mark/reset
158     * functionality.     * functionality.
159     *     *
160     * @param readlimit The number of chars that can be read before the mark     * @param readLimit The number of chars that can be read before the mark
161     *        becomes invalid     *        becomes invalid
162     *     *
163     * @exception IOException If an error occurs     * @exception IOException If an error occurs
# Line 240  public class BufferedReader extends Read Line 242  public class BufferedReader extends Read
242    
243    /**    /**
244     * This method determines whether or not a stream is ready to be read.  If     * This method determines whether or not a stream is ready to be read.  If
245     * This method returns <code>false</code> then this stream could (but is     * this method returns <code>false</code> then this stream could (but is
246     * not guaranteed to) block on the next read attempt.     * not guaranteed to) block on the next read attempt.
247     *     *
248     * @return <code>true</code> if this stream is ready to be read,     * @return <code>true</code> if this stream is ready to be read,
# Line 478  public class BufferedReader extends Read Line 480  public class BufferedReader extends Read
480     * <code>skip</code> method on the underlying stream to skip the     * <code>skip</code> method on the underlying stream to skip the
481     * remaining chars.     * remaining chars.
482     *     *
483     * @param num_chars The requested number of chars to skip     * @param numChars The requested number of chars to skip
484     *     *
485     * @return The actual number of chars skipped.     * @return The actual number of chars skipped.
486     *     *

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.18

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26