org.richfaces.json
Class JSContentHandler

java.lang.Object
  extended by org.richfaces.json.JSContentHandler
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler
Direct Known Subclasses:
MacroDefinitionJSContentHandler

public class JSContentHandler
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

Author:
shura SAX content handler for serialise events as JavaScript function.

Field Summary
static java.lang.String DEFAULT_ENCODING
           
protected  char[] indentBuffer
           
protected  int level
          The DocType instance representing the document.
protected  java.io.Writer outputWriter
           
 
Constructor Summary
JSContentHandler()
           
JSContentHandler(java.io.Writer outputWriter)
           
 
Method Summary
 void characters(char[] ch, int start, int length)
           
 void close()
           
protected  boolean closeElement(boolean end_element)
          Write the end part of a start element (if necessary).
 void comment(char[] ch, int start, int length)
           
protected  void encode(char[] data)
          Encode and write an array of characters.
protected  void encode(char[] data, int start, int length)
          Encode and write a specific part of an array of characters.
protected  void encode(java.lang.String data)
          Encode and write a String
protected  void encodeAttributeValue(org.xml.sax.Attributes attributes, int idx)
           
protected  void encodeText(char[] chars, int start, int length)
           
 void endCDATA()
           
 void endDocument()
           
 void endDTD()
           
 void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
           
 void endEntity(java.lang.String name)
           
 void endPrefixMapping(java.lang.String prefix)
           
 int getColumnNumber()
          Return the column number where the current document event ends.
 int getLineNumber()
          Return the line number where the current document event ends.
protected  java.lang.String getLocation()
          Return a String describing the current location.
 java.lang.String getPublicId()
          Return the public identifier for the current document event.
 java.lang.String getSystemId()
          Return the system identifier for the current document event.
 void ignorableWhitespace(char[] ch, int start, int length)
           
protected  boolean isBeforeDocumentStart()
           
protected  boolean isProcessingCdata()
           
 void processingInstruction(java.lang.String target, java.lang.String data)
           
 void setDocumentLocator(org.xml.sax.Locator locator)
          Receive an object for locating the origin of SAX document events.
 void skippedEntity(java.lang.String name)
           
 void startCDATA()
           
 void startDocument()
           
 void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
           
 void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
           
 void startEntity(java.lang.String name)
           
 void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
           
protected  void writeIndent(int indent)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

outputWriter

protected java.io.Writer outputWriter

level

protected int level
The DocType instance representing the document.


indentBuffer

protected char[] indentBuffer

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING
See Also:
Constant Field Values
Constructor Detail

JSContentHandler

public JSContentHandler()

JSContentHandler

public JSContentHandler(java.io.Writer outputWriter)
Parameters:
outputWriter -
Method Detail

close

public void close()
           throws java.io.IOException
Throws:
java.io.IOException

characters

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

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Specified by:
endDocument in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
Specified by:
endElement in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

closeElement

protected boolean closeElement(boolean end_element)
                        throws org.xml.sax.SAXException
Write the end part of a start element (if necessary).

Parameters:
end_element - Whether this method was called because an element is being closed or not.
Returns:
true if this call successfully closed the element (and no further </element> is required.
Throws:
org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException
Specified by:
endPrefixMapping in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException
Specified by:
ignorableWhitespace in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException
Specified by:
processingInstruction in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

setDocumentLocator

public final void setDocumentLocator(org.xml.sax.Locator locator)
Receive an object for locating the origin of SAX document events.

Specified by:
setDocumentLocator in interface org.xml.sax.ContentHandler

getPublicId

public java.lang.String getPublicId()
Return the public identifier for the current document event.

Returns:
A String containing the public identifier, or null if none is available.

getSystemId

public java.lang.String getSystemId()
Return the system identifier for the current document event.

Returns:
A String containing the system identifier, or null if none is available.

getLineNumber

public int getLineNumber()
Return the line number where the current document event ends.

Returns:
The line number, or -1 if none is available.

getColumnNumber

public int getColumnNumber()
Return the column number where the current document event ends.

Returns:
The column number, or -1 if none is available.

getLocation

protected java.lang.String getLocation()
Return a String describing the current location.


skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException
Specified by:
skippedEntity in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
Specified by:
startDocument in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException
Specified by:
startElement in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

encodeAttributeValue

protected void encodeAttributeValue(org.xml.sax.Attributes attributes,
                                    int idx)
                             throws org.xml.sax.SAXException,
                                    java.io.IOException
Throws:
org.xml.sax.SAXException
java.io.IOException

encodeText

protected void encodeText(char[] chars,
                          int start,
                          int length)
                   throws org.xml.sax.SAXException,
                          java.io.IOException
Throws:
org.xml.sax.SAXException
java.io.IOException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException
Specified by:
startPrefixMapping in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

comment

public void comment(char[] ch,
                    int start,
                    int length)
             throws org.xml.sax.SAXException
Specified by:
comment in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException
Specified by:
endCDATA in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

endDTD

public void endDTD()
            throws org.xml.sax.SAXException
Specified by:
endDTD in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException
Specified by:
endEntity in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

startCDATA

public void startCDATA()
                throws org.xml.sax.SAXException
Specified by:
startCDATA in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)
              throws org.xml.sax.SAXException
Specified by:
startDTD in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException
Specified by:
startEntity in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException

writeIndent

protected void writeIndent(int indent)
                    throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

encode

protected void encode(java.lang.String data)
               throws org.xml.sax.SAXException
Encode and write a String

Throws:
org.xml.sax.SAXException

encode

protected void encode(char[] data)
               throws org.xml.sax.SAXException
Encode and write an array of characters.

Throws:
org.xml.sax.SAXException

encode

protected void encode(char[] data,
                      int start,
                      int length)
               throws org.xml.sax.SAXException
Encode and write a specific part of an array of characters.

Throws:
org.xml.sax.SAXException

isProcessingCdata

protected boolean isProcessingCdata()

isBeforeDocumentStart

protected boolean isBeforeDocumentStart()


Copyright © 2010. All Rights Reserved.