FilterWriter (FlexDoc/Javadoc 2.0 Demo)

Abstract class for writing filtered character streams. The abstract class FilterWriter itself provides default methods that pass all requests to the contained stream. Subclasses of FilterWriter should override some of these methods and may also provide additional methods and fields.

Since:

1.1

Author:

Mark Reinhold

Field Summary
protected Writer	out The underlying character-output stream.

Fields inherited from class java.io.Writer

lock

Constructor Summary
protected	FilterWriter(Writer out) Create a new filtered writer.

Method Summary
void	close() Closes the stream, flushing it first.
void	flush() Flushes the stream.
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(int c) Writes a single character.
void	write(String str, int off, int len) Writes a portion of a string.

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

out

protected Writer out

The underlying character-output stream.

Constructor Detail

FilterWriter

protected FilterWriter

(Writer out)

Create a new filtered writer.

Parameters:

out - a Writer object to provide the underlying stream.

Throws:

NullPointerException - if out is null

Method Detail

write

public void write	(int c)
throws	IOException

Writes a single character.

Overrides:

write in class Writer

Parameters:

c - int specifying a character to be written

Throws:

IOException - If an I/O error occurs

write

public void write	(char[] cbuf, int off, int len)
throws	IOException

Writes a portion of an array of characters.

Overrides:

write in class Writer

Parameters:

cbuf - Buffer of characters to be written

off - Offset from which to start reading characters

len - Number of characters to be written

Throws:

IndexOutOfBoundsException - If the values of the off and len parameters cause the corresponding method of the underlying Writer to throw an IndexOutOfBoundsException

IOException - If an I/O error occurs

write

public void write	(String str, int off, int len)
throws	IOException

Writes a portion of a string.

Overrides:

write in class Writer

Parameters:

str - String to be written

off - Offset from which to start reading characters

len - Number of characters to be written

Throws:

IndexOutOfBoundsException - If the values of the off and len parameters cause the corresponding method of the underlying Writer to throw an IndexOutOfBoundsException

IOException - If an I/O error occurs

flush

public void flush	()
throws	IOException

Flushes the stream.

Specified by:

flush in interface Flushable

Overrides:

flush in class Writer

Throws:

IOException - If an I/O error occurs

public void close	()
throws	IOException

Description copied from class: Writer

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Specified by:

close in interface Closeable

close in interface AutoCloseable

Overrides:

close in class Writer

Throws:

IOException - If an I/O error occurs

Overview

Module

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS All Classes All Packages

FRAMES NO FRAMES

FlexDoc/Javadoc 2.0
Demo Java Doc

Java API documentation generated with FlexDoc/Javadoc 2.0 using JavadocClassic 3.0 template set.

FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch, FlexDoc/Javadoc may be the only tool able to help you! Find out more at www.flexdoc.xyz