com.Ostermiller.util

Class NoCloseWriter

java.lang.Object

java.io.Writer

com.Ostermiller.util.NoCloseWriter

All Implemented Interfaces:

NoCloseStream, java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class NoCloseWriter
extends java.io.Writer
implements NoCloseStream

A writer with a close method with no effect. More information about this class is available from ostermiller.org.

This class is designed to wrap a normal writer so that it can be passed to methods that write to it and may erroneously close it. This class is a workaround when the method cannot be modified because it is in a library.

Since:

ostermillerutils 1.01.00

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.Writer	out The writer that is being protected.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
NoCloseWriter(java.io.Writer out) Protect a new writer.

Method Summary

Modifier and Type	Method and Description
void	close() Has no effect.
void	flush()
void	reallyClose() Actually closes this stream and releases any system resources associated with the stream, as opposed to the close() method, which does nothing.
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

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

Field Detail

out

protected java.io.Writer out

The writer that is being protected. All methods should be forwarded to it, except for the close method, which should do nothing. The reallyClose method should actually close this stream.

Since:

ostermillerutils 1.01.00

Constructor Detail

NoCloseWriter

public NoCloseWriter(java.io.Writer out)

Protect a new writer.

Parameters:

out - The writer that is being protected.

Method Detail

write

public void write(int c)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char[] cbuf)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

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

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Has no effect.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

Since:

ostermillerutils 1.01.00

See Also:

reallyClose()

reallyClose

public void reallyClose()
                 throws java.io.IOException

Actually closes this stream and releases any system resources associated with the stream, as opposed to the close() method, which does nothing.

Specified by:

reallyClose in interface NoCloseStream

Throws:

java.io.IOException - if an I/O error occurs.