Package org.simpleframework.xml.stream
Class OutputBuffer
java.lang.Object
org.simpleframework.xml.stream.OutputBuffer
This is primarily used to replace the
StringBuffer
class, as a way for the Formatter
to store the start
tag for an XML element. This enables the start tag of the current
element to be removed without disrupting any of the other nodes
within the document. Once the contents of the output buffer have
been filled its contents can be emitted to the writer object.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringBuilder
The characters that this buffer has accumulated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(char ch) This will add achar
to the end of the buffer.void
append
(char[] value) This will add achar
array to the buffer.void
append
(char[] value, int off, int len) This will add achar
array to the buffer.void
This will add aString
to the end of the buffer.void
This will add aString
to the end of the buffer.void
clear()
This will empty theOutputBuffer
so that it does not contain any content.void
This method is used to write the contents of the buffer to the specifiedWriter
object.
-
Field Details
-
text
The characters that this buffer has accumulated.
-
-
Constructor Details
-
OutputBuffer
public OutputBuffer()Constructor forOutputBuffer
. The defaultOutputBuffer
stores 16 characters before a resize is needed to append extra characters.
-
-
Method Details
-
append
public void append(char ch) This will add achar
to the end of the buffer. The buffer will not overflow with repeated uses of theappend
, it uses anensureCapacity
method which will allow the buffer to dynamically grow in size to accommodate more characters.- Parameters:
ch
- the character to be appended to the buffer
-
append
This will add aString
to the end of the buffer. The buffer will not overflow with repeated uses of theappend
, it uses anensureCapacity
method which will allow the buffer to dynamically grow in size to accommodate large string objects.- Parameters:
value
- the string to be appended to this output buffer
-
append
public void append(char[] value) This will add achar
array to the buffer. The buffer will not overflow with repeated uses of theappend
, it uses anensureCapacity
method which will allow the buffer to dynamically grow in size to accommodate large character arrays.- Parameters:
value
- the character array to be appended to this
-
append
public void append(char[] value, int off, int len) This will add achar
array to the buffer. The buffer will not overflow with repeated uses of theappend
, it uses anensureCapacity
method which will allow the buffer to dynamically grow in size to accommodate large character arrays.- Parameters:
value
- the character array to be appended to thisoff
- the read offset for the array to begin readinglen
- the number of characters to append to this
-
append
This will add aString
to the end of the buffer. The buffer will not overflow with repeated uses of theappend
, it uses anensureCapacity
method which will allow the buffer to dynamically grow in size to accommodate large string objects.- Parameters:
value
- the string to be appended to the output bufferoff
- the offset to begin reading from the stringlen
- the number of characters to append to this
-
write
This method is used to write the contents of the buffer to the specifiedWriter
object. This is used when the XML element is to be committed to the resulting XML document.- Parameters:
out
- this is the writer to write the buffered text to- Throws:
IOException
- thrown if there is an I/O problem
-
clear
public void clear()This will empty theOutputBuffer
so that it does not contain any content. This is used to that when the buffer is written to a specifiedWriter
object nothing is written out. This allows XML elements to be removed.
-