org.vishia.util

Class Writer_Appendable

java.lang.Object

java.io.Writer

org.vishia.util.Writer_Appendable

All Implemented Interfaces:

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

public class Writer_Appendable
extends java.io.Writer

This class creates a java.io.Writer instance with a given Appendable.

• All write operations result to an output of the characters to the Appendable.append(char).
• The operations flush() flushes if the Writer_Appendable(Appendable, Flushable) was created with a flush instances. This instances may/should be the same as the Appendable instance. If a flush instance is not given, flush has no effect.
• The operations close() flushes and closes this instances. It closes the Flushable instance if it is Closeable

Since:

2015-07-15 LPGL-license.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Appendable	app
private java.io.Flushable	flush
static java.lang.String	sVersion Version, history and license.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
Writer_Appendable(java.lang.Appendable app) Instance which does not support flush(), but flush() can be called
Writer_Appendable(java.lang.Appendable app, java.io.Flushable flush) Instance which supports a maybe specific flush

Method Summary

Modifier and Type	Method and Description
void	clear() If the Appendable is also a CharSequence, such as StringBuilder, then return it.
void	close()
void	flush()
java.lang.CharSequence	getContent() If the Appendable is also a CharSequence, such as StringBuilder, then return it.
java.lang.String	toString() toString() should present the Appendable-content, if it is a StringBuilder, it's very proper.
void	write(char[] cbuf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2022-02-07 Hartmut: Enhanced with close and compatibility with a StringBuilder.
• 20xx: Created.

See Also:

Constant Field Values

app

private java.lang.Appendable app

flush

private final java.io.Flushable flush

Constructor Detail

Writer_Appendable

public Writer_Appendable(java.lang.Appendable app)

Instance which does not support flush(), but flush() can be called

Parameters:

app -

Writer_Appendable

public Writer_Appendable(java.lang.Appendable app,
                         java.io.Flushable flush)

Instance which supports a maybe specific flush

Parameters:

app - Can be the same as flush, if it is a Writer

flush - same as app or specific other.

Method Detail

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

getContent

public java.lang.CharSequence getContent()

If the Appendable is also a CharSequence, such as StringBuilder, then return it.

Returns:

clear

public void clear()

If the Appendable is also a CharSequence, such as StringBuilder, then return it.

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

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

toString

public java.lang.String toString()

toString() should present the Appendable-content, if it is a StringBuilder, it's very proper.

Overrides:

toString in class java.lang.Object