| java.lang.Object org.jasig.portal.serialize.BaseMarkupSerializer org.jasig.portal.serialize.TextSerializer
TextSerializer | public class TextSerializer extends BaseMarkupSerializer (Code) | | Implements a text serializer supporting both DOM and SAX
serializing. For usage instructions see
Serializer .
If an output stream is used, the encoding is taken from the
output format (defaults to UTF-8). If a writer is
used, make sure the writer uses the same encoding (if applies)
as specified in the output format.
The serializer supports both DOM and SAX. DOM serializing is done
by calling
TextSerializer.serialize and SAX serializing is done by firing
SAX events and using the serializer as a document handler.
If an I/O exception occurs while serializing, the serializer
will not throw an exception directly, but only throw it
at the end of serializing (either DOM or SAX's
org.xml.sax.DocumentHandler.endDocument .
version: $Revision: 36559 $ $Date: 2006-04-28 11:38:13 -0700 (Fri, 28 Apr 2006) $ author: Assaf Arkin See Also: Serializer |
Constructor Summary | |
public | TextSerializer() Constructs a new serializer. |
Method Summary | |
public void | characters(char[] chars, int start, int length) | protected void | characters(String text, boolean unescaped) | public void | comment(String text) | public void | comment(char[] chars, int start, int length) | protected ElementState | content() | public void | endElement(String namespaceURI, String localName, String rawName) | public void | endElement(String tagName) | public void | endElementIO(String tagName) | protected String | getEntityRef(int ch) | public void | processingInstructionIO(String target, String code) | protected void | serializeElement(Element elem) Called to serialize a DOM element. | protected void | serializeNode(Node node) Serialize the DOM node. | public void | setOutputFormat(OutputFormat format) | protected void | startDocument(String rootTagName) Called to serialize the document's DOCTYPE by the root element.
This method will check if it has not been called before (
TextSerializer._started ),
will serialize the document type declaration, and will serialize all
pre-root comments and PIs that were accumulated in the document
(see
TextSerializer.serializePreRoot ). | public void | startElement(String namespaceURI, String localName, String rawName, Attributes attrs) | public void | startElement(String tagName, AttributeList attrs) |
characters | public void characters(char[] chars, int start, int length) throws SAXException(Code) | | |
comment | public void comment(char[] chars, int start, int length)(Code) | | |
serializeNode | protected void serializeNode(Node node) throws IOException(Code) | | Serialize the DOM node. This method is unique to the Text serializer.
Parameters: node - The node to serialize |
startDocument | protected void startDocument(String rootTagName) throws IOException(Code) | | Called to serialize the document's DOCTYPE by the root element.
This method will check if it has not been called before (
TextSerializer._started ),
will serialize the document type declaration, and will serialize all
pre-root comments and PIs that were accumulated in the document
(see
TextSerializer.serializePreRoot ). Pre-root will be serialized even if
this is not the first root element of the document.
|
Methods inherited from org.jasig.portal.serialize.BaseMarkupSerializer | protected String appendAnchorIfNecessary(String elementName, String attributeName, String attributeValue)(Code)(Java Doc) public ContentHandler asContentHandler() throws IOException(Code)(Java Doc) public DOMSerializer asDOMSerializer() throws IOException(Code)(Java Doc) public DocumentHandler asDocumentHandler() throws IOException(Code)(Java Doc) public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException(Code)(Java Doc) public void characters(char[] chars, int start, int length) throws SAXException(Code)(Java Doc) protected void characters(String text) throws IOException(Code)(Java Doc) protected void checkUnboundNamespacePrefixedNode(Node node) throws IOException(Code)(Java Doc) public void comment(char[] chars, int start, int length) throws SAXException(Code)(Java Doc) public void comment(String text) throws IOException(Code)(Java Doc) protected ElementState content() throws IOException(Code)(Java Doc) public void elementDecl(String name, String model) throws SAXException(Code)(Java Doc) public void endCDATA()(Code)(Java Doc) public void endDTD()(Code)(Java Doc) public void endDocument() throws SAXException(Code)(Java Doc) public void endEntity(String name)(Code)(Java Doc) public void endNonEscaping()(Code)(Java Doc) public void endPrefixMapping(String prefix) throws SAXException(Code)(Java Doc) public void endPreserving()(Code)(Java Doc) protected ElementState enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace)(Code)(Java Doc) public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException(Code)(Java Doc) protected void fatalError(String message) throws IOException(Code)(Java Doc) protected ElementState getElementState()(Code)(Java Doc) abstract protected String getEntityRef(int ch)(Code)(Java Doc) protected String getPrefix(String namespaceURI)(Code)(Java Doc) public void ignorableWhitespace(char[] chars, int start, int length) throws SAXException(Code)(Java Doc) public void internalEntityDecl(String name, String value) throws SAXException(Code)(Java Doc) protected boolean isDocumentState()(Code)(Java Doc) protected ElementState leaveElementState()(Code)(Java Doc) protected DOMError modifyDOMError(String message, short severity, String type, Node node)(Code)(Java Doc) public void notationDecl(String name, String publicId, String systemId) throws SAXException(Code)(Java Doc) protected void prepare() throws IOException(Code)(Java Doc) protected void printCDATAText(String text) throws IOException(Code)(Java Doc) protected void printDoctypeURL(String url) throws IOException(Code)(Java Doc) protected void printEscaped(int ch) throws IOException(Code)(Java Doc) protected void printEscaped(String source) throws IOException(Code)(Java Doc) final void printHex(int ch) throws IOException(Code)(Java Doc) protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException(Code)(Java Doc) protected void printText(String text, boolean preserveSpace, boolean unescaped) throws IOException(Code)(Java Doc) final public void processingInstruction(String target, String code) throws SAXException(Code)(Java Doc) public void processingInstructionIO(String target, String code) throws IOException(Code)(Java Doc) public boolean reset()(Code)(Java Doc) public void serialize(Element elem) throws IOException(Code)(Java Doc) public void serialize(DocumentFragment frag) throws IOException(Code)(Java Doc) public void serialize(Document doc) throws IOException(Code)(Java Doc) abstract protected void serializeElement(Element elem) throws IOException(Code)(Java Doc) protected void serializeNode(Node node) throws IOException(Code)(Java Doc) protected void serializePreRoot() throws IOException(Code)(Java Doc) public void setDocumentLocator(Locator locator)(Code)(Java Doc) public void setOutputByteStream(OutputStream output)(Code)(Java Doc) public void setOutputCharStream(Writer writer)(Code)(Java Doc) public void setOutputFormat(OutputFormat format)(Code)(Java Doc) public void skippedEntity(String name) throws SAXException(Code)(Java Doc) public void startAnchoring(String anchorId)(Code)(Java Doc) public void startCDATA()(Code)(Java Doc) final public void startDTD(String name, String publicId, String systemId) throws SAXException(Code)(Java Doc) public void startDocument() throws SAXException(Code)(Java Doc) public void startEntity(String name)(Code)(Java Doc) public void startNonEscaping()(Code)(Java Doc) public void startPrefixMapping(String prefix, String uri) throws SAXException(Code)(Java Doc) public void startPreserving()(Code)(Java Doc) public void stopAnchoring()(Code)(Java Doc) protected void surrogates(int high, int low) throws IOException(Code)(Java Doc) public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException(Code)(Java Doc)
|
|
|