|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jsieve.util.XmlOut
public final class XmlOut
Lightweight SieveToXml#Out
implementation.
Requires a wrapper to be used safely in a multithreaded environment.
Not intended to be subclassed. Please copy and hack!
Constructor Summary | |
---|---|
XmlOut(java.io.Writer writer)
|
Method Summary | |
---|---|
void |
attribute(java.lang.CharSequence name,
java.lang.CharSequence value)
Writes an attribute of an element. |
void |
attribute(java.lang.CharSequence localName,
java.lang.CharSequence uri,
java.lang.CharSequence prefix,
java.lang.CharSequence value)
Outputs a attribute. |
void |
closeDocument()
Closes all pending elements. |
void |
closeElement()
Closes the last element written. |
void |
content(java.lang.CharSequence content)
Writes content. |
void |
openElement(java.lang.CharSequence elementName)
Writes the start of an element. |
void |
openElement(java.lang.CharSequence localName,
java.lang.CharSequence uri,
java.lang.CharSequence prefix)
Starts an XML element. |
void |
startDocument()
Starts a document by writing a prolog. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XmlOut(java.io.Writer writer)
Method Detail |
---|
public void startDocument() throws java.io.IOException
OperationNotAllowedException
- if called after the first element has been written
or once a prolog has already been written
java.io.IOException
public void openElement(java.lang.CharSequence elementName) throws java.io.IOException
elementName
- the name of the element, not null
InvalidXmlException
- if the name is not valid for an xml element
OperationNotAllowedException
- if called after the first element has been closed
java.io.IOException
public void attribute(java.lang.CharSequence name, java.lang.CharSequence value) throws java.io.IOException
openElement(CharSequence)
or attribute(java.lang.CharSequence, java.lang.CharSequence)
.
name
- the attribute name, not nullvalue
- the attribute value, not null
InvalidXmlException
- if the name is not valid for an xml attribute
or if a value for the attribute has already been written
OperationNotAllowedException
- if called after content(java.lang.CharSequence)
or #closeElement() or before any call to {@link #openElement}
java.io.IOException
public void content(java.lang.CharSequence content) throws java.io.IOException
content
in interface SieveToXml.Out
content
- the content to write
OperationNotAllowedException
- if called before any call to openElement(java.lang.CharSequence)
or after the first element has been closed
java.io.IOException
- when output failspublic void closeElement() throws java.io.IOException
closeElement
in interface SieveToXml.Out
OperationNotAllowedException
- if called before any call to openElement(java.lang.CharSequence)
or after the first element has been closed
java.io.IOException
- when output failspublic void closeDocument() throws java.io.IOException
OperationNotAllowedException
- if called before any call to openElement(java.lang.CharSequence)
java.io.IOException
public void attribute(java.lang.CharSequence localName, java.lang.CharSequence uri, java.lang.CharSequence prefix, java.lang.CharSequence value) throws java.io.IOException
SieveToXml.Out
attribute
in interface SieveToXml.Out
value
- unescaped XML attribute content, not null
java.io.IOException
- when output failspublic void openElement(java.lang.CharSequence localName, java.lang.CharSequence uri, java.lang.CharSequence prefix) throws java.io.IOException
SieveToXml.Out
openElement
in interface SieveToXml.Out
java.io.IOException
- when output fails
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |