ariba.util.io
Class TruncatingStringWriter

java.lang.Object
  java.io.Writer
      java.io.StringWriter
          ariba.util.io.TruncatingStringWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable

public class TruncatingStringWriter
extends StringWriter

Constructor Summary

TruncatingStringWriter(int maxSize)
Create a String buffer writer which will cap the size of the string.

Method Summary

StringWriter	append(char c) Appends the specified character to this writer.
StringWriter	append(CharSequence csq) Appends the specified character sequence to this writer.
StringWriter	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
void	write(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(String str) Write a string.
void	write(String str, int off, int len) Write a portion of a string.

Methods inherited from class java.io.StringWriter

close, flush, getBuffer, toString

Methods inherited from class java.io.Writer

write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TruncatingStringWriter

public TruncatingStringWriter(int maxSize)

Create a String buffer writer which will cap the size of the string.

Parameters:

maxSize - The approximate maxmimum size of the string to output.

Method Detail

write

public void write(int c)

Write a single character.

Overrides:

write in class StringWriter

write

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

Write a portion of an array of characters.

Overrides:

write in class StringWriter

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

write

public void write(String str)

Write a string.

Overrides:

write in class StringWriter

write

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

Write a portion of a string.

Overrides:

write in class StringWriter

Parameters:

str - String to be written

off - Offset from which to start writing characters

len - Number of characters to write

append

public StringWriter append(CharSequence csq)

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 StringWriter

Parameters:

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

Returns:

This writer

Since:

1.5

append

public StringWriter append(CharSequence csq,
                           int start,
                           int end)

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 StringWriter

Parameters:

csq - 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".

start - The index of the first character in the subsequence

end - 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()

Since:

1.5

append

public StringWriter 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 StringWriter

Parameters:

c - The 16-bit character to append

Returns:

This writer

Since:

1.5