|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.serialize.BaseMarkupSerializer
org.jasig.portal.serialize.HTMLSerializer
org.jasig.portal.serialize.CachingHTMLSerializer
Caching version of the HTML serializer
Serializer
Field Summary |
Fields inherited from class org.jasig.portal.serialize.HTMLSerializer |
XHTMLNamespace |
Constructor Summary | |
CachingHTMLSerializer()
Constructs a new serializer. |
|
CachingHTMLSerializer(OutputFormat format)
Constructs a new serializer. |
|
CachingHTMLSerializer(java.io.OutputStream output,
OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
CachingHTMLSerializer(java.io.Writer writer,
OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
void |
flush()
Flushes all the buffers |
java.lang.String |
getCache()
Asks serializer for an accumulated cache content. |
void |
printRawCharacters(java.lang.String text)
Allows one to print a String of characters directly to the output stream. |
void |
setDocumentStarted(boolean setting)
Let the serializer know if the document has already been started. |
void |
setOutputByteStream(java.io.OutputStream output)
Specifies an output stream to which the document should be serialized. |
void |
setOutputCharStream(java.io.Writer writer)
Specifies a writer to which the document should be serialized. |
void |
setOutputFormat(OutputFormat format)
Specifies an output format for this serializer. |
boolean |
startCaching()
Commands serializer to start caching. |
boolean |
stopCaching()
Commands serializer to stop caching. |
Methods inherited from class org.jasig.portal.serialize.HTMLSerializer |
characters, endElement, endElement, endElementIO, startAnchoring, startElement, startElement, stopAnchoring |
Methods inherited from class org.jasig.portal.serialize.BaseMarkupSerializer |
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, comment, comment, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, externalEntityDecl, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, processingInstructionIO, reset, serialize, serialize, serialize, setDocumentLocator, 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 |
public CachingHTMLSerializer()
setOutputCharStream(java.io.Writer)
or setOutputByteStream(java.io.OutputStream)
first.
public CachingHTMLSerializer(OutputFormat format)
setOutputCharStream(java.io.Writer)
or setOutputByteStream(java.io.OutputStream)
first.
public CachingHTMLSerializer(java.io.Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic CachingHTMLSerializer(java.io.OutputStream output, OutputFormat format)
output
- The output stream to useformat
- The output format to use, null for the defaultMethod Detail |
public void setOutputCharStream(java.io.Writer writer)
Serializer
setOutputCharStream
in interface Serializer
setOutputCharStream
in class BaseMarkupSerializer
public void setOutputByteStream(java.io.OutputStream output)
Serializer
setOutputByteStream
in interface Serializer
setOutputByteStream
in class BaseMarkupSerializer
public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
setOutputFormat
in class HTMLSerializer
public boolean startCaching() throws java.io.IOException
CachingSerializer
startCaching
in interface CachingSerializer
false
if the serializer is already caching.
java.io.IOException
public boolean stopCaching() throws java.io.IOException
CachingSerializer
stopCaching
in interface CachingSerializer
false
if the serializer was NOT caching.
java.io.IOException
public java.lang.String getCache() throws java.io.UnsupportedEncodingException, java.io.IOException
CachingSerializer
getCache
in interface CachingSerializer
String
cache.
java.io.UnsupportedEncodingException
- if the OutputFormat specified unsupported encoding
java.io.IOException
public void printRawCharacters(java.lang.String text) throws java.io.IOException
String
of characters directly to the output stream.
printRawCharacters
in interface CachingSerializer
text
- a String
value
java.io.IOException
public void setDocumentStarted(boolean setting)
setDocumentStarted
in interface CachingSerializer
setting
- a boolean
valuepublic void flush() throws java.io.IOException
CachingSerializer
flush
in interface CachingSerializer
java.io.IOException
- if an error occurs
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |