uPortal 2.4.1
API Documentation

org.jasig.portal.serialize
Class TextSerializer

java.lang.Object
  extended byorg.jasig.portal.serialize.BaseMarkupSerializer
      extended byorg.jasig.portal.serialize.TextSerializer
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.DocumentHandler, DOMSerializer, org.xml.sax.DTDHandler, org.xml.sax.ext.LexicalHandler, Serializer

public class TextSerializer
extends BaseMarkupSerializer

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 BaseMarkupSerializer.serialize(Element) 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 ContentHandler.endDocument().

Version:
$Revision: 1.3 $ $Date: 2004/09/10 17:17:27 $
Author:
Assaf Arkin
See Also:
Serializer

Constructor Summary
TextSerializer()
          Constructs a new serializer.
 
Method Summary
 void characters(char[] chars, int start, int length)
           
 void comment(char[] chars, int start, int length)
           
 void comment(java.lang.String text)
           
 void endElement(java.lang.String tagName)
           
 void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)
           
 void endElementIO(java.lang.String tagName)
           
 void processingInstructionIO(java.lang.String target, java.lang.String code)
           
 void setOutputFormat(OutputFormat format)
          Specifies an output format for this serializer.
 void startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs)
           
 void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs)
           
 
Methods inherited from class org.jasig.portal.serialize.BaseMarkupSerializer
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, externalEntityDecl, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, reset, serialize, serialize, serialize, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, unparsedEntityDecl
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextSerializer

public TextSerializer()
Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(Writer) or BaseMarkupSerializer.setOutputByteStream(OutputStream) first.

Method Detail

setOutputFormat

public void setOutputFormat(OutputFormat format)
Description copied from interface: Serializer
Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.

Specified by:
setOutputFormat in interface Serializer
Overrides:
setOutputFormat in class BaseMarkupSerializer

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

startElement

public void startElement(java.lang.String tagName,
                         org.xml.sax.AttributeList attrs)
                  throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

endElementIO

public void endElementIO(java.lang.String tagName)
                  throws java.io.IOException
Throws:
java.io.IOException

processingInstructionIO

public void processingInstructionIO(java.lang.String target,
                                    java.lang.String code)
                             throws java.io.IOException
Overrides:
processingInstructionIO in class BaseMarkupSerializer
Throws:
java.io.IOException

comment

public void comment(java.lang.String text)
Overrides:
comment in class BaseMarkupSerializer

comment

public void comment(char[] chars,
                    int start,
                    int length)
Specified by:
comment in interface org.xml.sax.ext.LexicalHandler
Overrides:
comment in class BaseMarkupSerializer

characters

public void characters(char[] chars,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
Specified by:
characters in interface org.xml.sax.ContentHandler
Overrides:
characters in class BaseMarkupSerializer
Throws:
org.xml.sax.SAXException

uPortal 2.4.1
API Documentation