com.phloc.commons.io.streams

Class NonBlockingStringWriter

java.lang.Object

java.io.Writer

com.phloc.commons.io.streams.NonBlockingStringWriter

All Implemented Interfaces:

IHasSize, IHasStringRepresentation, Closeable, Flushable, Serializable, Appendable, AutoCloseable

@NotThreadSafe
public class NonBlockingStringWriter
extends Writer
implements IHasStringRepresentation, IHasSize, Serializable

A non-synchronized copy of the class StringWriter.
It uses StringBuilder instead of StringBuffer and therefore does not need synchronized access!

Author:

Philip Helger

See Also:

StringWriter, Serialized Form

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
NonBlockingStringWriter() Create a new string writer using the default initial string-buffer size.
NonBlockingStringWriter(int nInitialSize) Create a new string writer using the specified initial string-buffer size.

Method Summary

Methods

Modifier and Type	Method and Description
NonBlockingStringWriter	append(char c) Appends the specified character to this writer.
NonBlockingStringWriter	append(CharSequence aCS) Appends the specified character sequence to this writer.
NonBlockingStringWriter	append(CharSequence aCS, int nStart, int nEnd) Appends a subsequence of the specified character sequence to this writer.
void	close() Closing a StringWriter has no effect.
StringBuilder	directGetStringBuilder()
void	flush() Flush the stream.
char[]	getAsCharArray()
String	getAsString()
boolean	isEmpty()
void	reset() Remove all content of the buffer.
int	size()
String	toString() Deprecated.
void	write(char[] aBuf, int nOfs, int nLen) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(String sStr) Write a string.
void	write(String sStr, int nOfs, int nLen) Write a portion of a string.

Methods inherited from class java.io.Writer

write

Methods inherited from class java.lang.Object

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

Constructor Detail

NonBlockingStringWriter

public NonBlockingStringWriter()

Create a new string writer using the default initial string-buffer size.

NonBlockingStringWriter

public NonBlockingStringWriter(@Nonnegative
                       int nInitialSize)

Create a new string writer using the specified initial string-buffer size.

Parameters:

nInitialSize - The number of char values that will fit into this buffer before it is automatically expanded

Throws:

IllegalArgumentException - If initialSize is negative

Method Detail

write

public void write(int c)

Write a single character.

Overrides:

write in class Writer

write

public void write(@Nonnull
         char[] aBuf,
         @Nonnegative
         int nOfs,
         @Nonnegative
         int nLen)

Write a portion of an array of characters.

Specified by:

write in class Writer

Parameters:

aBuf - Array of characters

nOfs - Offset from which to start writing characters

nLen - Number of characters to write

write

public void write(@Nullable
         String sStr)

Write a string.

Overrides:

write in class Writer

write

public void write(@Nonnull
         String sStr,
         int nOfs,
         int nLen)

Write a portion of a string.

Overrides:

write in class Writer

Parameters:

sStr - String to be written

nOfs - Offset from which to start writing characters

nLen - Number of characters to write

append

public NonBlockingStringWriter append(CharSequence aCS)

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

 out.write (csq.toString ())
 

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

aCS - The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns:

This writer

append

public NonBlockingStringWriter append(CharSequence aCS,
                             int nStart,
                             int nEnd)

Appends a subsequence of the specified character sequence to this writer.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

 out.write (csq.subSequence (start, end).toString ())
 

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

aCS - The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".

nStart - The index of the first character in the subsequence

nEnd - The index of the character following the last character in the subsequence

Returns:

This writer

Throws:

IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()

append

public NonBlockingStringWriter append(char c)

Appends the specified character to this writer.

An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation

 out.write (c)
 

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

c - The 16-bit character to append

Returns:

This writer

flush

public void flush()

Flush the stream.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public void close()

Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

directGetStringBuilder

@Nonnull
@ReturnsMutableObject(reason="design")
public StringBuilder directGetStringBuilder()

Returns:

The contained StringBuilder. Never null. Handle with care!

getAsCharArray

@Nonnull
@ReturnsMutableCopy
public char[] getAsCharArray()

Returns:

Return the buffer's current value as a string.

getAsString

@Nonnull
public String getAsString()

Specified by:

getAsString in interface IHasStringRepresentation

Returns:

the buffer's current value as a string.

reset

public void reset()

Remove all content of the buffer.

size

@Nonnegative
public int size()

Specified by:

size in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size()

toString

@Deprecated
@DevelopersNote(value="Use getAsString as it is more explicit!")
public String toString()

Deprecated.

Overrides:

toString in class Object

Returns:

the buffer's current value as a string.