BufferedWriter - Android SDK

Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

BufferedWriter

extends Writer

java.lang.Object
↳	java.io.Writer
	↳	java.io.BufferedWriter

Class Overview

Wraps an existing Writer and buffers the output. Expensive interaction with the underlying reader is minimized, since most (smaller) requests can be satisfied by accessing the buffer alone. The drawback is that some extra space is required to hold the buffer and that copying takes place when filling that buffer, but this is usually outweighed by the performance benefits.

A typical application pattern for the class looks like this:

 BufferedWriter buf = new BufferedWriter(new FileWriter("file.java"));

Summary

[Expand]

Inherited Fields

From class java.io.Writer

Public Constructors
	BufferedWriter(Writer out) Constructs a new `BufferedWriter`, providing `out` with a buffer of 8192 chars.
	BufferedWriter(Writer out, int size) Constructs a new `BufferedWriter`, providing `out` with `size` chars of buffer.

Public Methods
void	close() Closes this writer.
void	flush() Flushes this writer.
void	newLine() Writes a newline to this writer.
void	write(char[] buffer, int offset, int count) Writes `count` characters starting at `offset` in `buffer` to this writer.
void	write(String str, int offset, int count) Writes `count` characters starting at `offset` in `str` to this writer.
void	write(int oneChar) Writes the character `oneChar` to this writer.

[Expand]

Inherited Methods

From class java.io.Writer

Writer	append(CharSequence csq) Appends the character sequence `csq` to the target.
Writer	append(CharSequence csq, int start, int end) Appends a subsequence of the character sequence `csq` to the target.
Writer	append(char c) Appends the character `c` to the target.
abstract void	close() Closes this writer.
abstract void	flush() Flushes this writer.
void	write(char[] buf) Writes the entire character buffer `buf` to the target.
void	write(String str) Writes the characters from the specified string to the target.
abstract void	write(char[] buf, int offset, int count) Writes `count` characters starting at `offset` in `buf` to the target.
void	write(String str, int offset, int count) Writes `count` characters from `str` starting at `offset` to the target.
void	write(int oneChar) Writes one character to the target.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.lang.Appendable

From interface java.io.Closeable

From interface java.io.Flushable

From interface java.lang.AutoCloseable

Public Constructors

public BufferedWriter (Writer out)

Added in API level 1

Constructs a new BufferedWriter, providing out with a buffer of 8192 chars.

Parameters

out	the `Writer` the buffer writes to.

public BufferedWriter (Writer out, int size)

Added in API level 1

Constructs a new BufferedWriter, providing out with size chars of buffer.

Parameters

out	the `OutputStream` the buffer writes to.
size	the size of buffer in chars.

Throws

IllegalArgumentException	if `size <= 0`.

Public Methods

public void close ()

Added in API level 1

Closes this writer. The contents of the buffer are flushed, the target writer is closed, and the buffer is released. Only the first invocation of close has any effect.

Throws

IOException	if an error occurs while closing this writer.

public void flush ()

Added in API level 1

Flushes this writer. The contents of the buffer are committed to the target writer and it is then flushed.

Throws

IOException	if an error occurs while flushing this writer.

public void newLine ()

Added in API level 1

Writes a newline to this writer. On Android, this is "\n". The target writer may or may not be flushed when a newline is written.

Throws

IOException	if an error occurs attempting to write to this writer.

public void write (char[] buffer, int offset, int count)

Added in API level 1

Writes count characters starting at offset in buffer to this writer. If count is greater than this writer's buffer, then the buffer is flushed and the characters are written directly to the target writer.

Parameters

buffer	the array containing characters to write.
offset	the start position in `buffer` for retrieving characters.
count	the maximum number of characters to write.

Throws

IndexOutOfBoundsException	if `offset < 0` or `count < 0`, or if `offset + count` is greater than the size of `buffer`.
IOException	if this writer is closed or another I/O error occurs.

public void write (String str, int offset, int count)

Added in API level 1

Writes count characters starting at offset in str to this writer. If count is greater than this writer's buffer, then this writer is flushed and the remaining characters are written directly to the target writer. If count is negative no characters are written to the buffer. This differs from the behavior of the superclass.

Parameters

str	the non-null String containing characters to write.
offset	the start position in `str` for retrieving characters.
count	maximum number of characters to write.

Throws

IOException	if this writer has already been closed or another I/O error occurs.
IndexOutOfBoundsException	if `offset < 0` or `offset + count` is greater than the length of `str`.

public void write (int oneChar)

Added in API level 1

Writes the character oneChar to this writer. If the buffer gets full by writing this character, this writer is flushed. Only the lower two bytes of the integer oneChar are written.

Parameters

oneChar	the character to write.

Throws

IOException	if this writer is closed or another I/O error occurs.

Results

Interfaces

Classes

Exceptions

Errors

BufferedWriter

Class Overview

See Also

Summary

Public Constructors

public BufferedWriter (Writer out)

Parameters

public BufferedWriter (Writer out, int size)

Parameters

Throws

Public Methods

public void close ()

Throws

public void flush ()

Throws

public void newLine ()

Throws

public void write (char[] buffer, int offset, int count)

Parameters

Throws

public void write (String str, int offset, int count)

Parameters

Throws

public void write (int oneChar)

Parameters

Throws