|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.betwixt.io.AbstractBeanWriter org.apache.commons.betwixt.io.BeanWriter
public class BeanWriter
BeanWriter
outputs beans as XML to an io stream.
The output for each bean is an xml fragment (rather than a well-formed xml-document). This allows bean representations to be appended to a document by writing each in turn to the stream. So to create a well formed xml document, you'll need to write the prolog to the stream first. If you append more than one bean to the stream, then you'll need to add a wrapping root element as well.
The line ending to be used is set by setEndOfLine(java.lang.String)
.
The output can be formatted (with whitespace) for easy reading
by calling enablePrettyPrint()
.
The output will be indented.
The indent string used is set by setIndent(java.lang.String)
.
Bean graphs can sometimes contain cycles.
Care must be taken when serializing cyclic bean graphs
since this can lead to infinite recursion.
The approach taken by BeanWriter
is to automatically
assign an ID
attribute value to beans.
When a cycle is encountered,
an element is written that has the IDREF
attribute set to the
id assigned earlier.
The names of the ID
and IDREF
attributes used
can be customized by the XMLBeanInfo
.
The id's used can also be customized by the user
via IDGenerator
subclasses.
The implementation used can be set by the IdGenerator
property.
BeanWriter defaults to using SequentialIDGenerator
which supplies id values in numeric sequence.
If generated ID
attribute values are not acceptable in the output,
then this can be disabled by setting the WriteIDs
property to false.
If a cyclic reference is encountered in this case then a
CyclicReferenceException
will be thrown.
When the WriteIDs
property is set to false,
it is recommended that this exception is caught by the caller.
Constructor Summary | |
---|---|
BeanWriter()
Constructor uses System.out for output. |
|
BeanWriter(java.io.OutputStream out)
Constuctor uses given OutputStream for output. |
|
BeanWriter(java.io.OutputStream out,
java.lang.String enc)
Constuctor uses given OutputStream for output
and allows encoding to be set. |
|
BeanWriter(java.io.Writer writer)
Constructor sets writer used for output. |
Method Summary | |
---|---|
protected void |
bodyText(WriteContext context,
java.lang.String text)
Write element body text |
void |
close()
Closes the underlying output stream |
void |
enablePrettyPrint()
Switch on formatted output. |
protected void |
endElement(WriteContext context,
java.lang.String uri,
java.lang.String localName,
java.lang.String qualifiedName)
Writes the end tag for an element |
protected java.lang.String |
escapeAttributeValue(java.lang.Object value)
Deprecated. 0.5 moved into utility class XMLUtils.escapeAttributeValue(java.lang.Object) |
protected java.lang.String |
escapeBodyValue(java.lang.Object value)
Deprecated. 0.5 moved into utility class XMLUtils.escapeBodyValue(java.lang.Object) |
protected void |
expressAttribute(java.lang.String qualifiedName,
java.lang.String value)
Deprecated. 0.5 replaced by new SAX inspired API |
protected void |
expressBodyText(java.lang.String text)
Deprecated. 0.5 replaced by new SAX inspired API |
protected void |
expressElementEnd()
Deprecated. 0.5 replaced by new SAX inspired API |
protected void |
expressElementEnd(java.lang.String qualifiedName)
Deprecated. 0.5 replaced by new SAX inspired API |
protected void |
expressElementStart(java.lang.String qualifiedName)
Deprecated. 0.5 replaced by new SAX inspired API |
protected void |
expressTagClose()
Deprecated. 0.5 replaced by new SAX inspired API |
void |
flush()
Allows output to be flushed on the underlying output stream |
java.lang.String |
getEndOfLine()
Gets the string used to mark end of lines. |
java.lang.String |
getIndent()
Gets the indent string |
int |
getInitialIndentLevel()
Gets the initial indent level |
org.apache.commons.logging.Log |
getLog()
Set the log implementation used. |
MixedContentEncodingStrategy |
getMixedContentEncodingStrategy()
Gets the encoding strategy for mixed content. |
boolean |
isEndTagForEmptyElement()
Should an end tag be added for each empty element? |
void |
setEndOfLine(java.lang.String endOfLine)
Sets the string used for end of lines Produces a warning the specified value contains an invalid whitespace character |
void |
setEndTagForEmptyElement(boolean addEndTagForEmptyElement)
Sets when an an end tag be added for each empty element. |
void |
setIndent(java.lang.String indent)
Sets the string used for pretty print indents |
void |
setInitialIndentLevel(int initialIndentLevel)
Sets the initial indent level used for pretty print indents |
void |
setLog(org.apache.commons.logging.Log log)
Set the log implementation used. |
void |
setMixedContentEncodingStrategy(MixedContentEncodingStrategy strategy)
Sets the encoding strategy for mixed content. |
protected void |
startElement(WriteContext context,
java.lang.String uri,
java.lang.String localName,
java.lang.String qualifiedName,
org.xml.sax.Attributes attr)
Writes the start tag for an element. |
void |
write(java.lang.Object bean)
Write the given object to the stream (and then flush). |
protected void |
writeIndent()
Deprecated. 0.5 replaced by new SAX inspired API |
protected void |
writePrintln()
Deprecated. 0.5 replaced by new SAX inspired API |
void |
writeXmlDeclaration(java.lang.String xmlDeclaration)
A helper method that allows you to write the XML Declaration. |
Methods inherited from class org.apache.commons.betwixt.io.AbstractBeanWriter |
---|
bodyText, end, endElement, expressAttribute, expressElementEnd, expressElementStart, getAbstractBeanWriterLog, getBindingConfiguration, getIdGenerator, getIndentLevel, getWriteEmptyElements, getWriteIDs, getXMLIntrospector, popBean, pushBean, setAbstractBeanWriterLog, setBindingConfiguration, setIdGenerator, setWriteEmptyElements, setWriteIDs, setXMLIntrospector, start, startElement, write, write, write, write, writeAttribute, writeAttributes, writeContent, writeIDREFElement, writeRestOfElement |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BeanWriter()
Constructor uses System.out
for output.
public BeanWriter(java.io.OutputStream out)
Constuctor uses given OutputStream
for output.
out
- write out representations to this streampublic BeanWriter(java.io.OutputStream out, java.lang.String enc) throws java.io.UnsupportedEncodingException
Constuctor uses given OutputStream
for output
and allows encoding to be set.
out
- write out representations to this streamenc
- the name of the encoding to be used. This should be compatible
with the encoding types described in java.io
java.io.UnsupportedEncodingException
- if the given encoding is not supportedpublic BeanWriter(java.io.Writer writer)
Constructor sets writer used for output.
writer
- write out representations to this writerMethod Detail |
---|
public void writeXmlDeclaration(java.lang.String xmlDeclaration) throws java.io.IOException
xmlDeclaration
- is the XML declaration string typically of
the form "<xml version='1.0' encoding='UTF-8' ?>
java.io.IOException
- when declaration cannot be writtenpublic void flush() throws java.io.IOException
java.io.IOException
- when the flush cannot be completedpublic void close() throws java.io.IOException
java.io.IOException
- when writer cannot be closedpublic void write(java.lang.Object bean) throws java.io.IOException, org.xml.sax.SAXException, java.beans.IntrospectionException
write
in class AbstractBeanWriter
bean
- write this Object
to the stream
java.io.IOException
- if an IO problem causes failure
org.xml.sax.SAXException
- if a SAX problem causes failure
java.beans.IntrospectionException
- if bean cannot be introspectedpublic void enablePrettyPrint()
Switch on formatted output. This sets the end of line and the indent. The default is adding 2 spaces and a newline
public java.lang.String getEndOfLine()
public void setEndOfLine(java.lang.String endOfLine)
endOfLine
- the String
public int getInitialIndentLevel()
public void setInitialIndentLevel(int initialIndentLevel)
initialIndentLevel
- use this int
to start withpublic java.lang.String getIndent()
public void setIndent(java.lang.String indent)
indent
- use this string
for indentspublic org.apache.commons.logging.Log getLog()
Set the log implementation used.
org.apache.commons.logging.Log
level constantpublic void setLog(org.apache.commons.logging.Log log)
Set the log implementation used.
log
- Log
implementation to usepublic MixedContentEncodingStrategy getMixedContentEncodingStrategy()
MixedContentEncodingStrategy
, not nullpublic void setMixedContentEncodingStrategy(MixedContentEncodingStrategy strategy)
strategy
- the MixedContentEncodingStrategy
used to process body content, not nullpublic boolean isEndTagForEmptyElement()
Should an end tag be added for each empty element?
When this property is false then empty elements will
be written as <element-name/gt;
.
When this property is true then empty elements will
be written as <element-namegt;
</element-namegt;
.
public void setEndTagForEmptyElement(boolean addEndTagForEmptyElement)
<element-name/gt;
.
When this property is true then empty elements will
be written as <element-namegt;
</element-namegt;
.
addEndTagForEmptyElement
- true if an end tag should be
written for each empty element, false otherwiseprotected void startElement(WriteContext context, java.lang.String uri, java.lang.String localName, java.lang.String qualifiedName, org.xml.sax.Attributes attr) throws java.io.IOException, org.xml.sax.SAXException
startElement
in class AbstractBeanWriter
uri
- the element's namespace urilocalName
- the element's local namequalifiedName
- the element's qualified nameattr
- the element's attributes
java.io.IOException
- if an IO problem occurs during writing
org.xml.sax.SAXException
- if an SAX problem occurs during writingprotected void endElement(WriteContext context, java.lang.String uri, java.lang.String localName, java.lang.String qualifiedName) throws java.io.IOException, org.xml.sax.SAXException
endElement
in class AbstractBeanWriter
uri
- the element's namespace urilocalName
- the element's local namequalifiedName
- the element's qualified name
java.io.IOException
- if an IO problem occurs during writing
org.xml.sax.SAXException
- if an SAX problem occurs during writingprotected void bodyText(WriteContext context, java.lang.String text) throws java.io.IOException
bodyText
in class AbstractBeanWriter
text
- write out this body text
java.io.IOException
- when the stream write failsprotected void writePrintln() throws java.io.IOException
endOfLine
.
writePrintln
in class AbstractBeanWriter
java.io.IOException
- when stream write failsprotected void writeIndent() throws java.io.IOException
indent
's to the current indentLevel
writeIndent
in class AbstractBeanWriter
java.io.IOException
- when stream write failsprotected java.lang.String escapeBodyValue(java.lang.Object value)
XMLUtils.escapeBodyValue(java.lang.Object)
Escape the toString
of the given object.
For use as body text.
value
- escape value.toString()
protected java.lang.String escapeAttributeValue(java.lang.Object value)
XMLUtils.escapeAttributeValue(java.lang.Object)
Escape the toString
of the given object.
For use in an attribute value.
value
- escape value.toString()
protected void expressElementStart(java.lang.String qualifiedName) throws java.io.IOException
expressElementStart
in class AbstractBeanWriter
qualifiedName
- the fully qualified name of the element to write
java.io.IOException
- when stream write failsprotected void expressTagClose() throws java.io.IOException
expressTagClose
in class AbstractBeanWriter
java.io.IOException
- when stream write failsprotected void expressElementEnd(java.lang.String qualifiedName) throws java.io.IOException
expressElementEnd
in class AbstractBeanWriter
qualifiedName
- the name of the element
java.io.IOException
- when stream write failsprotected void expressElementEnd() throws java.io.IOException
expressElementEnd
in class AbstractBeanWriter
java.io.IOException
- when stream write failsprotected void expressBodyText(java.lang.String text) throws java.io.IOException
expressBodyText
in class AbstractBeanWriter
text
- write out this body text
java.io.IOException
- when the stream write failsprotected void expressAttribute(java.lang.String qualifiedName, java.lang.String value) throws java.io.IOException
expressAttribute
in class AbstractBeanWriter
qualifiedName
- fully qualified attribute namevalue
- attribute value
java.io.IOException
- when the stream write fails
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |