Java Doc for CachingHTMLSerializer.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » serialize » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.serialize 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jasig.portal.serialize.BaseMarkupSerializer
      org.jasig.portal.serialize.HTMLSerializer
         org.jasig.portal.serialize.CachingHTMLSerializer

CachingHTMLSerializer
final public class CachingHTMLSerializer extends HTMLSerializer implements CachingSerializer(Code)
Caching version of the HTML serializer
author:
   Peter Kharchenko
author:
   Assaf Arkin
See Also:   Serializer


Field Summary
 CharacterCachingWritercacher
    
 Stringencoding
    

Constructor Summary
public  CachingHTMLSerializer()
     Constructs a new serializer.
protected  CachingHTMLSerializer(boolean xhtml, OutputFormat format)
     Constructs a new HTML/XHTML serializer depending on the value of xhtml.
public  CachingHTMLSerializer(OutputFormat format)
     Constructs a new serializer.
public  CachingHTMLSerializer(Writer writer, OutputFormat format)
     Constructs a new serializer that writes to the specified writer using the specified output format.
public  CachingHTMLSerializer(OutputStream output, OutputFormat format)
     Constructs a new serializer that writes to the specified output stream using the specified output format.

Method Summary
public  voidflush()
    
public  StringgetCache()
    
public  voidprintRawCharacters(String text)
     Allows one to print a String of characters directly to the output stream.
public  voidsetDocumentStarted(boolean setting)
     Let the serializer know if the document has already been started.
public  voidsetOutputByteStream(OutputStream output)
    
public  voidsetOutputCharStream(Writer writer)
    
public  voidsetOutputFormat(OutputFormat format)
    
public  booleanstartCaching()
     When starting caching if we are inside an opening tag the ">" will be written in order for the ">" to be included with the correct cache. Normally the serializer doesn't know if a ">" or "/>" should be written until some content is received or the tag is closed.
public  booleanstopCaching()
     When stopping caching if we are inside an opening tag the ">" will be written in order for the ">" to be included with the correct cache. Normally the serializer doesn't know if a ">" or "/>" should be written until some content is received or the tag is closed.

Field Detail
cacher
CharacterCachingWriter cacher(Code)



encoding
String encoding(Code)




Constructor Detail
CachingHTMLSerializer
public CachingHTMLSerializer()(Code)
Constructs a new serializer. The serializer cannot be used without calling CachingHTMLSerializer.setOutputCharStream or CachingHTMLSerializer.setOutputByteStream first.



CachingHTMLSerializer
protected CachingHTMLSerializer(boolean xhtml, OutputFormat format)(Code)
Constructs a new HTML/XHTML serializer depending on the value of xhtml. The serializer cannot be used without calling init() first.
Parameters:
  xhtml - True if XHTML serializing



CachingHTMLSerializer
public CachingHTMLSerializer(OutputFormat format)(Code)
Constructs a new serializer. The serializer cannot be used without calling CachingHTMLSerializer.setOutputCharStream or CachingHTMLSerializer.setOutputByteStream first.



CachingHTMLSerializer
public CachingHTMLSerializer(Writer writer, OutputFormat format)(Code)
Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.
Parameters:
  writer - The writer to use
Parameters:
  format - The output format to use, null for the default



CachingHTMLSerializer
public CachingHTMLSerializer(OutputStream output, OutputFormat format)(Code)
Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.
Parameters:
  output - The output stream to use
Parameters:
  format - The output format to use, null for the default




Method Detail
flush
public void flush() throws IOException(Code)



getCache
public String getCache() throws UnsupportedEncodingException, IOException(Code)



printRawCharacters
public void printRawCharacters(String text) throws IOException(Code)
Allows one to print a String of characters directly to the output stream.
Parameters:
  text - a String value



setDocumentStarted
public void setDocumentStarted(boolean setting)(Code)
Let the serializer know if the document has already been started.
Parameters:
  setting - a boolean value



setOutputByteStream
public void setOutputByteStream(OutputStream output)(Code)



setOutputCharStream
public void setOutputCharStream(Writer writer)(Code)



setOutputFormat
public void setOutputFormat(OutputFormat format)(Code)



startCaching
public boolean startCaching() throws IOException(Code)
When starting caching if we are inside an opening tag the ">" will be written in order for the ">" to be included with the correct cache. Normally the serializer doesn't know if a ">" or "/>" should be written until some content is received or the tag is closed. When starting caching after an opening tag the tag will be assumed to have some content and will write out the ">" before starting the cache.



stopCaching
public boolean stopCaching() throws IOException(Code)
When stopping caching if we are inside an opening tag the ">" will be written in order for the ">" to be included with the correct cache. Normally the serializer doesn't know if a ">" or "/>" should be written until some content is received or the tag is closed. When starting caching after an opening tag the tag will be assumed to have some content and will write out the ">" before starting the cache.



Fields inherited from org.jasig.portal.serialize.HTMLSerializer
final public static String XHTMLNamespace(Code)(Java Doc)

Methods inherited from org.jasig.portal.serialize.HTMLSerializer
protected String appendAnchorIfNecessary(String elementName, String attributeName, String attributeValue)(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)
public void endElement(String namespaceURI, String localName, String rawName) throws SAXException(Code)(Java Doc)
public void endElement(String tagName) throws SAXException(Code)(Java Doc)
public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException(Code)(Java Doc)
protected String escapeURI(String uri)(Code)(Java Doc)
protected String getEntityRef(int ch)(Code)(Java Doc)
protected void serializeElement(Element elem) throws IOException(Code)(Java Doc)
public void setOutputFormat(OutputFormat format)(Code)(Java Doc)
public void setXHTMLNamespace(String newNamespace)(Code)(Java Doc)
public boolean shouldNotExpandEndTagForEmptyElement(String elementName)(Code)(Java Doc)
public void startAnchoring(String anchorId)(Code)(Java Doc)
protected void startDocument(String rootTagName) throws IOException(Code)(Java Doc)
public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException(Code)(Java Doc)
public void startElement(String tagName, AttributeList attrs) throws SAXException(Code)(Java Doc)
public void stopAnchoring()(Code)(Java Doc)

Fields inherited from org.jasig.portal.serialize.BaseMarkupSerializer
protected String _docTypePublicId(Code)(Java Doc)
protected String _docTypeSystemId(Code)(Java Doc)
protected EncodingInfo _encodingInfo(Code)(Java Doc)
protected OutputFormat _format(Code)(Java Doc)
protected boolean _indenting(Code)(Java Doc)
protected Hashtable _prefixes(Code)(Java Doc)
protected Printer _printer(Code)(Java Doc)
protected boolean _started(Code)(Java Doc)
protected String anchorId(Code)(Java Doc)
protected Node fCurrentNode(Code)(Java Doc)
final protected DOMErrorImpl fDOMError(Code)(Java Doc)
protected DOMErrorHandler fDOMErrorHandler(Code)(Java Doc)
protected LSSerializerFilter fDOMFilter(Code)(Java Doc)
final protected StringBuffer fStrBuffer(Code)(Java Doc)
protected short features(Code)(Java Doc)
boolean html4compat(Code)(Java Doc)

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)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.