|
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.utils.SAX2FilterImpl
org.jasig.portal.utils.SAX2BufferImpl
A basic XML buffer implementation.
Field Summary | |
static java.lang.Integer |
CHARACTERS
|
static java.lang.Integer |
COMMENT
|
static java.lang.Integer |
ENDCDATA
|
static java.lang.Integer |
ENDDOCUMENT
|
static java.lang.Integer |
ENDDTD
|
static java.lang.Integer |
ENDELEMENT
|
static java.lang.Integer |
ENDENTITY
|
static java.lang.Integer |
ENDPREFIXMAPPING
|
static java.lang.Integer |
ERROR
|
static java.lang.Integer |
FATALERROR
|
static java.lang.Integer |
IGNORABLEWHITESPACE
|
static java.lang.Integer |
NOTATIONDECL
|
static java.lang.Integer |
PROCESSINGINSTRUCTION
|
static java.lang.Integer |
SKIPPEDENTITY
|
static java.lang.Integer |
STARTCDATA
|
static java.lang.Integer |
STARTDOCUMENT
|
static java.lang.Integer |
STARTDTD
|
static java.lang.Integer |
STARTELEMENT
|
static java.lang.Integer |
STARTENTITY
|
static java.lang.Integer |
STARTPREFIXMAPPING
|
static java.lang.Integer |
UNPARSEDENTITYDECL
|
static java.lang.Integer |
WARNING
|
Constructor Summary | |
SAX2BufferImpl()
Construct an empty XML buffer, with no parent. |
|
SAX2BufferImpl(org.xml.sax.ContentHandler ch)
Construct an XML filter based on a unified handler. |
|
SAX2BufferImpl(org.xml.sax.ContentHandler ch,
org.xml.sax.EntityResolver er,
org.xml.sax.ErrorHandler eh,
org.xml.sax.ext.LexicalHandler lh,
org.xml.sax.DTDHandler dh)
Construct an XML filter with the specified children. |
|
SAX2BufferImpl(org.xml.sax.XMLReader parent)
Construct an XML filter with the specified parent. |
Method Summary | |
void |
characters(char[] ch,
int start,
int length)
Filter a character data event. |
void |
clearBuffer()
|
void |
comment(char[] ch,
int start,
int length)
Filter comment event. |
void |
endCDATA()
Filter endCDATA event. |
void |
endDocument()
Filter an end document event. |
void |
endDTD()
Filter endDTD event |
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
Filter an end element event. |
void |
endEntity(java.lang.String name)
Filter endEntity event. |
void |
endPrefixMapping(java.lang.String prefix)
Filter an end Namespace prefix mapping event. |
void |
error(org.xml.sax.SAXParseException e)
Filter an error event. |
void |
fatalError(org.xml.sax.SAXParseException e)
Filter a fatal error event. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Filter an ignorable whitespace event. |
boolean |
isEmpty()
|
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Filter a notation declaration event. |
void |
outputBuffer()
Outputs buffer's content to a current set of handlers. |
void |
outputBuffer(org.xml.sax.ContentHandler ch)
Outputs buffer's content to a specified content handler. |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Filter a processing instruction event. |
void |
setDocumentLocator(org.xml.sax.Locator locator)
Filter a new document locator event. |
void |
setOutputAtDocumentEnd(boolean setting)
Tells buffer to automatically output itself once an end of a document is reached. |
void |
skippedEntity(java.lang.String name)
Filter a skipped entity event. |
void |
startBuffering()
|
void |
startCDATA()
Filter startCDATA event. |
void |
startDocument()
Filter a start document event. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Filter startDTD event. |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
Filter a start element event. |
void |
startEntity(java.lang.String name)
Filter startEntity event. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Filter a start Namespace prefix mapping event. |
void |
stopBuffering()
|
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
Filter an unparsed entity declaration event. |
void |
warning(org.xml.sax.SAXParseException e)
Filter a warning event. |
Methods inherited from class org.jasig.portal.utils.SAX2FilterImpl |
getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, parse, parse, resolveEntity, setAllHandlers, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setLexicalHandler, setParent, setProperty |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.Integer STARTDOCUMENT
public static final java.lang.Integer ENDDOCUMENT
public static final java.lang.Integer STARTELEMENT
public static final java.lang.Integer ENDELEMENT
public static final java.lang.Integer CHARACTERS
public static final java.lang.Integer IGNORABLEWHITESPACE
public static final java.lang.Integer PROCESSINGINSTRUCTION
public static final java.lang.Integer NOTATIONDECL
public static final java.lang.Integer UNPARSEDENTITYDECL
public static final java.lang.Integer STARTPREFIXMAPPING
public static final java.lang.Integer ENDPREFIXMAPPING
public static final java.lang.Integer SKIPPEDENTITY
public static final java.lang.Integer WARNING
public static final java.lang.Integer ERROR
public static final java.lang.Integer FATALERROR
public static final java.lang.Integer COMMENT
public static final java.lang.Integer STARTCDATA
public static final java.lang.Integer ENDCDATA
public static final java.lang.Integer STARTDTD
public static final java.lang.Integer ENDDTD
public static final java.lang.Integer STARTENTITY
public static final java.lang.Integer ENDENTITY
Constructor Detail |
public SAX2BufferImpl()
This filter will have no parent: you must assign a parent before you start a parse or do any configuration with setFeature or setProperty.
By default, buffering is on, outputAtDocumentEnd is off.
XMLReader.setFeature(java.lang.String, boolean)
,
XMLReader.setProperty(java.lang.String, java.lang.Object)
public SAX2BufferImpl(org.xml.sax.XMLReader parent)
Same default flag settings as with empty constructor
SAX2FilterImpl.setParent(XMLReader)
,
SAX2FilterImpl.getParent()
public SAX2BufferImpl(org.xml.sax.ContentHandler ch, org.xml.sax.EntityResolver er, org.xml.sax.ErrorHandler eh, org.xml.sax.ext.LexicalHandler lh, org.xml.sax.DTDHandler dh)
Same default flag settings as with empty constructor
SAX2FilterImpl.setContentHandler(ContentHandler)
,
SAX2FilterImpl.setDTDHandler(DTDHandler)
,
SAX2FilterImpl.setErrorHandler(ErrorHandler)
,
SAX2FilterImpl.setEntityResolver(EntityResolver)
,
SAX2FilterImpl.setLexicalHandler(LexicalHandler)
public SAX2BufferImpl(org.xml.sax.ContentHandler ch)
Same default flag settings as with empty constructor.
Method Detail |
public void setOutputAtDocumentEnd(boolean setting)
setting
- a boolean
valuepublic void clearBuffer()
public void stopBuffering() throws org.xml.sax.SAXException
org.xml.sax.SAXException
public void startBuffering()
public boolean isEmpty()
public void outputBuffer() throws org.xml.sax.SAXException
org.xml.sax.SAXException
- if an error occurspublic void outputBuffer(org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException
ch
- a ContenteHandler
value
org.xml.sax.SAXException
- if an error occurspublic void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
SAX2FilterImpl
startDTD
in interface org.xml.sax.ext.LexicalHandler
startDTD
in class SAX2FilterImpl
name
- The document type name.publicId
- The declared public identifier for the
external DTD subset, or null if none was declared.systemId
- The declared system identifier for the
external DTD subset, or null if none was declared.
org.xml.sax.SAXException
- The application may raise an
exception.SAX2FilterImpl.endDTD()
,
SAX2FilterImpl.startEntity(java.lang.String)
public void endDTD() throws org.xml.sax.SAXException
SAX2FilterImpl
endDTD
in interface org.xml.sax.ext.LexicalHandler
endDTD
in class SAX2FilterImpl
org.xml.sax.SAXException
- The application may raise an exception.SAX2FilterImpl.startDTD(java.lang.String, java.lang.String, java.lang.String)
public void startEntity(java.lang.String name) throws org.xml.sax.SAXException
SAX2FilterImpl
startEntity
in interface org.xml.sax.ext.LexicalHandler
startEntity
in class SAX2FilterImpl
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.
org.xml.sax.SAXException
- The application may raise an exception.SAX2FilterImpl.endEntity(java.lang.String)
,
DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)
,
DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
public void endEntity(java.lang.String name) throws org.xml.sax.SAXException
SAX2FilterImpl
endEntity
in interface org.xml.sax.ext.LexicalHandler
endEntity
in class SAX2FilterImpl
name
- The name of the entity that is ending.
org.xml.sax.SAXException
- The application may raise an exception.SAX2FilterImpl.startEntity(java.lang.String)
public void startCDATA() throws org.xml.sax.SAXException
SAX2FilterImpl
startCDATA
in interface org.xml.sax.ext.LexicalHandler
startCDATA
in class SAX2FilterImpl
org.xml.sax.SAXException
- The application may raise an exception.SAX2FilterImpl.endCDATA()
public void endCDATA() throws org.xml.sax.SAXException
SAX2FilterImpl
endCDATA
in interface org.xml.sax.ext.LexicalHandler
endCDATA
in class SAX2FilterImpl
org.xml.sax.SAXException
- The application may raise an exception.SAX2FilterImpl.startCDATA()
public void comment(char[] ch, int start, int length) throws org.xml.sax.SAXException
SAX2FilterImpl
comment
in interface org.xml.sax.ext.LexicalHandler
comment
in class SAX2FilterImpl
ch
- An array holding the characters in the comment.start
- The starting position in the array.length
- The number of characters to use from the array.
org.xml.sax.SAXException
- The application may raise an exception.public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
SAX2FilterImpl
notationDecl
in interface org.xml.sax.DTDHandler
notationDecl
in class SAX2FilterImpl
name
- The notation name.publicId
- The notation's public identifier, or null.systemId
- The notation's system identifier, or null.
org.xml.sax.SAXException
- The client may throw
an exception during processing.DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) throws org.xml.sax.SAXException
SAX2FilterImpl
unparsedEntityDecl
in interface org.xml.sax.DTDHandler
unparsedEntityDecl
in class SAX2FilterImpl
name
- The entity name.publicId
- The entity's public identifier, or null.systemId
- The entity's system identifier, or null.notationName
- The name of the associated notation.
org.xml.sax.SAXException
- The client may throw
an exception during processing.DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void setDocumentLocator(org.xml.sax.Locator locator)
SAX2FilterImpl
setDocumentLocator
in interface org.xml.sax.ContentHandler
setDocumentLocator
in class SAX2FilterImpl
locator
- The document locator.ContentHandler.setDocumentLocator(org.xml.sax.Locator)
public void startDocument() throws org.xml.sax.SAXException
SAX2FilterImpl
startDocument
in interface org.xml.sax.ContentHandler
startDocument
in class SAX2FilterImpl
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.startDocument()
public void endDocument() throws org.xml.sax.SAXException
SAX2FilterImpl
endDocument
in interface org.xml.sax.ContentHandler
endDocument
in class SAX2FilterImpl
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.endDocument()
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.SAXException
SAX2FilterImpl
startPrefixMapping
in interface org.xml.sax.ContentHandler
startPrefixMapping
in class SAX2FilterImpl
prefix
- The Namespace prefix.uri
- The Namespace URI.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
SAX2FilterImpl
endPrefixMapping
in interface org.xml.sax.ContentHandler
endPrefixMapping
in class SAX2FilterImpl
prefix
- The Namespace prefix.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.endPrefixMapping(java.lang.String)
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
SAX2FilterImpl
startElement
in interface org.xml.sax.ContentHandler
startElement
in class SAX2FilterImpl
uri
- The element's Namespace URI, or the empty string.localName
- The element's local name, or the empty string.qName
- The element's qualified (prefixed) name, or the empty
string.atts
- The element's attributes.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
SAX2FilterImpl
endElement
in interface org.xml.sax.ContentHandler
endElement
in class SAX2FilterImpl
uri
- The element's Namespace URI, or the empty string.localName
- The element's local name, or the empty string.qName
- The element's qualified (prefixed) name, or the empty
string.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
public void characters(char[] ch, int start, int length) throws org.xml.sax.SAXException
SAX2FilterImpl
characters
in interface org.xml.sax.ContentHandler
characters
in class SAX2FilterImpl
ch
- An array of characters.start
- The starting position in the array.length
- The number of characters to use from the array.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.characters(char[], int, int)
public void ignorableWhitespace(char[] ch, int start, int length) throws org.xml.sax.SAXException
SAX2FilterImpl
ignorableWhitespace
in interface org.xml.sax.ContentHandler
ignorableWhitespace
in class SAX2FilterImpl
ch
- An array of characters.start
- The starting position in the array.length
- The number of characters to use from the array.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.ignorableWhitespace(char[], int, int)
public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.SAXException
SAX2FilterImpl
processingInstruction
in interface org.xml.sax.ContentHandler
processingInstruction
in class SAX2FilterImpl
target
- The processing instruction target.data
- The text following the target.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.processingInstruction(java.lang.String, java.lang.String)
public void skippedEntity(java.lang.String name) throws org.xml.sax.SAXException
SAX2FilterImpl
skippedEntity
in interface org.xml.sax.ContentHandler
skippedEntity
in class SAX2FilterImpl
name
- The name of the skipped entity.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ContentHandler.skippedEntity(java.lang.String)
public void warning(org.xml.sax.SAXParseException e) throws org.xml.sax.SAXException
SAX2FilterImpl
warning
in interface org.xml.sax.ErrorHandler
warning
in class SAX2FilterImpl
e
- The nwarning as an exception.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ErrorHandler.warning(org.xml.sax.SAXParseException)
public void error(org.xml.sax.SAXParseException e) throws org.xml.sax.SAXException
SAX2FilterImpl
error
in interface org.xml.sax.ErrorHandler
error
in class SAX2FilterImpl
e
- The error as an exception.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ErrorHandler.error(org.xml.sax.SAXParseException)
public void fatalError(org.xml.sax.SAXParseException e) throws org.xml.sax.SAXException
SAX2FilterImpl
fatalError
in interface org.xml.sax.ErrorHandler
fatalError
in class SAX2FilterImpl
e
- The error as an exception.
org.xml.sax.SAXException
- The client may throw
an exception during processing.ErrorHandler.fatalError(org.xml.sax.SAXParseException)
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |