|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.ws.commons.serialize.XMLWriterImpl
public class XMLWriterImpl
Default implementation of XMLWriter
. Works with Java 1.2 and
later.
Field Summary | |
---|---|
(package private) int |
curIndent
|
Constructor Summary | |
---|---|
XMLWriterImpl()
|
Method Summary | |
---|---|
boolean |
canEncode(char c)
Returns whether the XMLWriter can encode the character c without an escape sequence like &#ddd;. |
void |
characters(char[] ch,
int start,
int length)
Inserts a string of characters into the document. |
void |
endDocument()
This method finishs the handlers action. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
Terminates an element. |
void |
endPrefixMapping(java.lang.String prefix)
Terminates use of a namespace prefix. |
org.xml.sax.Locator |
getDocumentLocator()
Returns the locator |
java.lang.String |
getEncoding()
Returns the writers encoding. |
java.lang.String |
getIndentString()
Returns the string being used to indent an XML element by one level. |
java.lang.String |
getLineFeed()
Returns the line terminator. |
java.io.Writer |
getWriter()
Returns the JaxbXMLSerializers Writer. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Calls the character method with the same arguments. |
boolean |
isDeclarating()
Returns, whether an XML declaration is being generated. |
boolean |
isFlushing()
Returns, whether the method ContentHandler.endDocument()
should do a flush on the target stream. |
boolean |
isIndenting()
Returns, whether the XMLWriter is indenting
(pretty printing). |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Inserts a processing instruction. |
void |
setDeclarating(boolean pDeclarating)
Sets, whether an XML declaration is being generated. |
void |
setDocumentLocator(org.xml.sax.Locator pLocator)
Sets the locator. |
void |
setEncoding(java.lang.String pEncoding)
Sets the writers encoding. |
void |
setFlushing(boolean pFlushing)
Sets, whether the method ContentHandler.endDocument()
should do a flush on the target stream. |
void |
setIndenting(boolean pIndenting)
Returns, whether the XMLWriter is indenting
(pretty printing). |
void |
setIndentString(java.lang.String pIndentString)
Sets the string being used to indent an XML element by one level. |
void |
setLineFeed(java.lang.String pLineFeed)
Sets the line terminator. |
void |
setWriter(java.io.Writer pWriter)
Sets the JaxbXMLSerializers Writer. |
void |
skippedEntity(java.lang.String ent)
Not actually implemented, because I don't know how to skip entities. |
void |
startDocument()
Starts a document. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes attr)
Starts a new element. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String namespaceURI)
Starts use of a namespace prefix. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
int curIndent
Constructor Detail |
---|
public XMLWriterImpl()
Method Detail |
---|
public void setEncoding(java.lang.String pEncoding)
XMLWriter
setEncoding
in interface XMLWriter
pEncoding
- Writers encoding, by default null, in
which case UTF-8 is being used.public java.lang.String getEncoding()
XMLWriter
getEncoding
in interface XMLWriter
public void setDeclarating(boolean pDeclarating)
XMLWriter
setDeclarating
in interface XMLWriter
pDeclarating
- Whether an XML declaration is generated. Defaults
to false.public boolean isDeclarating()
XMLWriter
isDeclarating
in interface XMLWriter
public void setIndenting(boolean pIndenting)
XMLWriter
XMLWriter
is indenting
(pretty printing). If you want indenting,
you should consider to invoke the methods
XMLWriter.setIndentString(java.lang.String)
and
XMLWriter.setLineFeed(java.lang.String)
as well.
setIndenting
in interface XMLWriter
pIndenting
- Whether indentation is enabled. Defaults to false.public boolean isIndenting()
XMLWriter
XMLWriter
is indenting
(pretty printing). If you want indenting,
you should consider to invoke the methods
XMLWriter.setIndentString(java.lang.String)
and
XMLWriter.setLineFeed(java.lang.String)
as well.
isIndenting
in interface XMLWriter
public void setIndentString(java.lang.String pIndentString)
XMLWriter
setIndentString
in interface XMLWriter
pIndentString
- The indentation string, by default " " (two blanks).public java.lang.String getIndentString()
XMLWriter
getIndentString
in interface XMLWriter
public void setLineFeed(java.lang.String pLineFeed)
XMLWriter
setLineFeed
in interface XMLWriter
pLineFeed
- The line terminator, by default "\n"
(Line Feed). You might prefer "\r\n" (Carriage Return,
Line Feed), which is the default on Windows and related
operating systems.public java.lang.String getLineFeed()
XMLWriter
getLineFeed
in interface XMLWriter
public void setFlushing(boolean pFlushing)
XMLWriter
ContentHandler.endDocument()
should do a flush on the target stream.
setFlushing
in interface XMLWriter
pFlushing
- True, if a flush should be done. Defaults to
false.public boolean isFlushing()
XMLWriter
ContentHandler.endDocument()
should do a flush on the target stream.
isFlushing
in interface XMLWriter
public void setWriter(java.io.Writer pWriter)
Sets the JaxbXMLSerializers Writer.
setWriter
in interface XMLWriter
pWriter
- The target writer.public java.io.Writer getWriter()
Returns the JaxbXMLSerializers Writer.
getWriter
in interface XMLWriter
public void setDocumentLocator(org.xml.sax.Locator pLocator)
setDocumentLocator
in interface org.xml.sax.ContentHandler
pLocator
- A locator for use in case of errorsgetDocumentLocator()
public org.xml.sax.Locator getDocumentLocator()
setDocumentLocator(org.xml.sax.Locator)
public void startPrefixMapping(java.lang.String prefix, java.lang.String namespaceURI) throws org.xml.sax.SAXException
Starts use of a namespace prefix.
startPrefixMapping
in interface org.xml.sax.ContentHandler
namespaceURI
- The namespace URIprefix
- The prefix
org.xml.sax.SAXException
- Not actually thrown, just for compliance to the interface specification.public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
Terminates use of a namespace prefix.
endPrefixMapping
in interface org.xml.sax.ContentHandler
prefix
- The prefix being abandoned.
org.xml.sax.SAXException
- Not actually thrown, just for compliance to the interface specification.public void startDocument() throws org.xml.sax.SAXException
Starts a document.
startDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- Not actually thrown, just for compliance to the interface specification.public void endDocument() throws org.xml.sax.SAXException
This method finishs the handlers action. After calling endDocument you may start a new action by calling startDocument again.
endDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- Not actually thrown, just for compliance to the
interface specification.public void ignorableWhitespace(char[] ch, int start, int length) throws org.xml.sax.SAXException
ignorableWhitespace
in interface org.xml.sax.ContentHandler
ch
- A string of whitespace characters being inserted into the document.start
- The index of the first character.length
- The number of characters.
org.xml.sax.SAXException
- Thrown in case of an IOException.public void characters(char[] ch, int start, int length) throws org.xml.sax.SAXException
characters
in interface org.xml.sax.ContentHandler
ch
- The characters being inserted. A substring, to be precise.start
- Index of the first characterlength
- Number of characters being inserted
org.xml.sax.SAXException
- Thrown in case of an IOExceptionpublic boolean canEncode(char c)
XMLWriter
Returns whether the XMLWriter can encode the character
c
without an escape sequence like &#ddd;.
canEncode
in interface XMLWriter
c
- The character being checked for escaping.
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
Terminates an element.
endElement
in interface org.xml.sax.ContentHandler
namespaceURI
- The namespace URI, if any, or nulllocalName
- The local name, without prefix, or nullqName
- The qualified name, including a prefix, or null
org.xml.sax.SAXException
- Thrown in case of an IOException.public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attr) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.ContentHandler
namespaceURI
- The namespace URI, if any, or nulllocalName
- The local name, without prefix, or nullqName
- The qualified name, including a prefix, or nullattr
- The element attributes
org.xml.sax.SAXException
- Thrown in case of an IOException.public void skippedEntity(java.lang.String ent) throws org.xml.sax.SAXException
skippedEntity
in interface org.xml.sax.ContentHandler
ent
- The entity being skipped.
org.xml.sax.SAXException
- Not actually thrown, just for compliance to the interface specification.public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.SAXException
processingInstruction
in interface org.xml.sax.ContentHandler
target
- The PI targetdata
- The PI data
org.xml.sax.SAXException
- Thrown in case of an IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |