BBossStringWriter (bboss-util 5.2.7 API)

java.lang.Object
- java.io.Writer
- - org.frameworkset.soa.BBossStringWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
```
public class BBossStringWriter
extends java.io.Writer
```

Field Summary
- Fields inherited from class java.io.Writer
  lock

Constructor Summary

Constructors
Constructor and Description
`BBossStringWriter()` Create a new string writer using the default initial string-buffer size.
`BBossStringWriter(int initialSize)` Create a new string writer using the specified initial string-buffer size.
`BBossStringWriter(java.lang.StringBuilder buf)` Create a new string writer using the default initial string-buffer size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BBossStringWriter`	`append(char c)` Appends the specified character to this writer.
`BBossStringWriter`	`append(java.lang.CharSequence csq)` Appends the specified character sequence to this writer.
`BBossStringWriter`	`append(java.lang.CharSequence csq, int start, int end)` Appends a subsequence of the specified character sequence to this writer.
`void`	`close()` Closing a `StringWriter` has no effect.
`void`	`flush()` Flush the stream.
`java.lang.StringBuilder`	`getBuffer()` Return the string buffer itself.
`java.lang.String`	`toString()` Return the buffer's current value as a string.
`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(java.lang.String str)` Write a string.
`void`	`write(java.lang.String str, int off, int len)` 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
  - BBossStringWriter
```
public BBossStringWriter(java.lang.StringBuilder buf)
```
    Create a new string writer using the default initial string-buffer size.
  - BBossStringWriter
```
public BBossStringWriter()
```
    Create a new string writer using the default initial string-buffer size.
  - BBossStringWriter
```
public BBossStringWriter(int initialSize)
```
    Create a new string writer using the specified initial string-buffer size.
    
    Parameters:
    
    initialSize - The number of char values that will fit into this buffer before it is automatically expanded
    
    Throws:
    
    java.lang.IllegalArgumentException - If initialSize is negative
- Method Detail
  - write
```
public void write(int c)
```
    Write a single character.
    
    Overrides:
    
    write in class java.io.Writer
  - write
```
public void write(char[] cbuf,
                  int off,
                  int len)
```
    Write a portion of an array of characters.
    
    Specified by:
    
    write in class java.io.Writer
    
    Parameters:
    
    cbuf - Array of characters
    
    off - Offset from which to start writing characters
    
    len - Number of characters to write
  - write
```
public void write(java.lang.String str)
```
    Write a string.
    
    Overrides:
    
    write in class java.io.Writer
  - write
```
public void write(java.lang.String str,
                  int off,
                  int len)
```
    Write a portion of a string.
    
    Overrides:
    
    write in class java.io.Writer
    
    Parameters:
    
    str - String to be written
    
    off - Offset from which to start writing characters
    
    len - Number of characters to write
  - append
```
public BBossStringWriter append(java.lang.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 java.lang.Appendable
    
    Overrides:
    
    append in class java.io.Writer
    
    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 BBossStringWriter append(java.lang.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 java.lang.Appendable
    
    Overrides:
    
    append in class java.io.Writer
    
    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:
    
    java.lang.IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()
    
    Since:
    
    1.5
  - append
```
public BBossStringWriter 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 java.lang.Appendable
    
    Overrides:
    
    append in class java.io.Writer
    
    Parameters:
    
    c - The 16-bit character to append
    
    Returns:
    
    This writer
    
    Since:
    
    1.5
  - toString
```
public java.lang.String toString()
```
    Return the buffer's current value as a string.
    
    Overrides:
    
    toString in class java.lang.Object
  - getBuffer
```
public java.lang.StringBuilder getBuffer()
```
    Return the string buffer itself.
    
    Returns:
    
    StringBuilder holding the current buffer value.
  - flush
```
public void flush()
```
    Flush the stream.
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Specified by:
    
    flush in class java.io.Writer
  - close
```
public void close()
           throws java.io.IOException
```
    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 java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in class java.io.Writer
    
    Throws:
    
    java.io.IOException

Class BBossStringWriter

Field Summary

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

Methods inherited from class java.io.Writer

Methods inherited from class java.lang.Object

Constructor Detail

BBossStringWriter

BBossStringWriter

BBossStringWriter

Method Detail

write

write

write

write

append

append

append

toString

getBuffer

flush

close