Logback Core Module 1.5.1 · ch.qos.logback.core.joran.event.SaxEventRecorder

Modifier and Type	Field and Description
pack-priv final ContextAwareImpl	contextAwareImpl
pack-priv final ElementPath	elementPath
pack-priv Locator	locator
pack-priv List<SaxEvent>	saxEventList

Access	Constructor and Description
public	SaxEventRecorder(Context context)
public	SaxEventRecorder(Context context, ElementPath elementPath)

Method Summary

Modifier and Type	Method and Description
public void	addError(String msg) Implements ch.qos.logback.core.spi.ContextAware.addError.
public void	addError(String msg, Throwable ex) Implements ch.qos.logback.core.spi.ContextAware.addError.
public void	addInfo(String msg) Implements ch.qos.logback.core.spi.ContextAware.addInfo.
public void	addInfo(String msg, Throwable ex) Implements ch.qos.logback.core.spi.ContextAware.addInfo.
public void	addStatus(Status status) Implements ch.qos.logback.core.spi.ContextAware.addStatus.
public void	addWarn(String msg) Implements ch.qos.logback.core.spi.ContextAware.addWarn.
public void	addWarn(String msg, Throwable ex) Implements ch.qos.logback.core.spi.ContextAware.addWarn.
private SAXParser	buildSaxParser()
public void	characters(char[] The characters. ch, int The start position in the character array. start, int The number of characters to use from the character array. length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Receive notification of character data inside an element.
public void	endElement(String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. namespaceURI, String The local name (without prefix), or the empty string if Namespace processing is not being performed. localName, String The qualified name (with prefix), or the empty string if qualified names are not available. qName) Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element.
public void	error(SAXParseException The error information encoded as an exception. spe) Overrides org.xml.sax.helpers.DefaultHandler.error. Implements org.xml.sax.ErrorHandler.error. Receive notification of a recoverable parser error.
public void	fatalError(SAXParseException The error information encoded as an exception. spe) Overrides org.xml.sax.helpers.DefaultHandler.fatalError. Implements org.xml.sax.ErrorHandler.fatalError. Report a fatal XML parsing error.
public Context	getContext() Implements ch.qos.logback.core.spi.ContextAware.getContext.
pack-priv SaxEvent	getLastEvent()
public Locator	getLocator()
public List<SaxEvent>	getSaxEventList()
pack-priv String	getTagName(String localName, String qName)
private void	handleError(String errMsg, Throwable t)
pack-priv boolean	isSpaceOnly(String bodyStr)
public final void	recordEvents(InputStream inputStream)
public void	recordEvents(InputSource inputSource)
public void	setContext(Context context) Implements ch.qos.logback.core.spi.ContextAware.setContext.
public void	setDocumentLocator(Locator A locator for all SAX document events. l) Overrides org.xml.sax.helpers.DefaultHandler.setDocumentLocator. Implements org.xml.sax.ContentHandler.setDocumentLocator. Receive a Locator object for document events.
protected boolean	shouldIgnoreForElementPath(String tagName)
public void	startDocument() Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Receive notification of the beginning of the document.
public void	startElement(String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. namespaceURI, String The local name (without prefix), or the empty string if Namespace processing is not being performed. localName, String The qualified name (with prefix), or the empty string if qualified names are not available. qName, Attributes The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. atts) Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Receive notification of the start of an element.
public void	warning(SAXParseException The warning information encoded as an exception. spe) Overrides org.xml.sax.helpers.DefaultHandler.warning. Implements org.xml.sax.ErrorHandler.warning. Receive notification of a parser warning.

Inherited from org.xml.sax.helpers.DefaultHandler:: endDocument endPrefixMapping ignorableWhitespace notationDecl processingInstruction resolveEntity skippedEntity startPrefixMapping unparsedEntityDecl

contextAwareImpl	back to summary
pack-priv final ContextAwareImpl contextAwareImpl

elementPath	back to summary
pack-priv final ElementPath elementPath

locator	back to summary
pack-priv Locator locator

saxEventList	back to summary
pack-priv List<SaxEvent> saxEventList

SaxEventRecorder	back to summary
public SaxEventRecorder(Context context)

SaxEventRecorder	back to summary
public SaxEventRecorder(Context context, ElementPath elementPath)

Method Detail

addError	back to summary
public void addError(String msg) Implements ch.qos.logback.core.spi.ContextAware.addError.

addError	back to summary
public void addError(String msg, Throwable ex) Implements ch.qos.logback.core.spi.ContextAware.addError.

addInfo	back to summary
public void addInfo(String msg) Implements ch.qos.logback.core.spi.ContextAware.addInfo.

addInfo	back to summary
public void addInfo(String msg, Throwable ex) Implements ch.qos.logback.core.spi.ContextAware.addInfo.

addStatus	back to summary
public void addStatus(Status status) Implements ch.qos.logback.core.spi.ContextAware.addStatus.

addWarn	back to summary
public void addWarn(String msg) Implements ch.qos.logback.core.spi.ContextAware.addWarn.

addWarn	back to summary
public void addWarn(String msg, Throwable ex) Implements ch.qos.logback.core.spi.ContextAware.addWarn.

buildSaxParser	back to summary
private SAXParser buildSaxParser() throws JoranException

characters	back to summary
public void characters(char[] ch, int start, int length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Doc from org.xml.sax.helpers.DefaultHandler.characters. Receive notification of character data inside an element. By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file). Parameters ch:char[] The characters. start:int The start position in the character array. length:int The number of characters to use from the character array.

characters

back to summary

public void characters(char[] ch, int start, int length)

Overrides org.xml.sax.helpers.DefaultHandler.characters.

Implements org.xml.sax.ContentHandler.characters.

Doc from org.xml.sax.helpers.DefaultHandler.characters.

Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

Parameters

ch:char[]: The characters.
start:int: The start position in the character array.
length:int: The number of characters to use from the character array.

endElement	back to summary
public void endElement(String namespaceURI, String localName, String qName) Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Doc from org.xml.sax.helpers.DefaultHandler.endElement. Receive notification of the end of an element. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file). Parameters namespaceURI:String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. localName:String The local name (without prefix), or the empty string if Namespace processing is not being performed. qName:String The qualified name (with prefix), or the empty string if qualified names are not available.

endElement

back to summary

public void endElement(String namespaceURI, String localName, String qName)

Overrides org.xml.sax.helpers.DefaultHandler.endElement.

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.helpers.DefaultHandler.endElement.

Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

Parameters

namespaceURI:String: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName:String: The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName:String: The qualified name (with prefix), or the empty string if qualified names are not available.

error	back to summary
public void error(SAXParseException spe) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.error. Implements org.xml.sax.ErrorHandler.error. Doc from org.xml.sax.helpers.DefaultHandler.error. Receive notification of a recoverable parser error. The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console. Parameters spe:SAXParseException The error information encoded as an exception. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

error

back to summary

public void error(SAXParseException spe) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.error.

Implements org.xml.sax.ErrorHandler.error.

Doc from org.xml.sax.helpers.DefaultHandler.error.

Receive notification of a recoverable parser error.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.

Parameters

spe:SAXParseException: The error information encoded as an exception.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

fatalError	back to summary
public void fatalError(SAXParseException spe) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.fatalError. Implements org.xml.sax.ErrorHandler.fatalError. Doc from org.xml.sax.helpers.DefaultHandler.fatalError. Report a fatal XML parsing error. The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events. Parameters spe:SAXParseException The error information encoded as an exception. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

fatalError

back to summary

public void fatalError(SAXParseException spe) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.fatalError.

Implements org.xml.sax.ErrorHandler.fatalError.

Doc from org.xml.sax.helpers.DefaultHandler.fatalError.

Report a fatal XML parsing error.

The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.

Parameters

spe:SAXParseException: The error information encoded as an exception.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

getContext	back to summary
public Context getContext() Implements ch.qos.logback.core.spi.ContextAware.getContext.

getLastEvent	back to summary
pack-priv SaxEvent getLastEvent()

getLocator	back to summary
public Locator getLocator()

getSaxEventList	back to summary
public List<SaxEvent> getSaxEventList()

getTagName	back to summary
pack-priv String getTagName(String localName, String qName)

handleError	back to summary
private void handleError(String errMsg, Throwable t) throws JoranException

isSpaceOnly	back to summary
pack-priv boolean isSpaceOnly(String bodyStr)

recordEvents	back to summary
public final void recordEvents(InputStream inputStream) throws JoranException

recordEvents	back to summary
public void recordEvents(InputSource inputSource) throws JoranException

setContext	back to summary
public void setContext(Context context) Implements ch.qos.logback.core.spi.ContextAware.setContext.

setDocumentLocator	back to summary
public void setDocumentLocator(Locator l) Overrides org.xml.sax.helpers.DefaultHandler.setDocumentLocator. Implements org.xml.sax.ContentHandler.setDocumentLocator. Doc from org.xml.sax.helpers.DefaultHandler.setDocumentLocator. Receive a Locator object for document events. By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events. Parameters l:Locator A locator for all SAX document events.

setDocumentLocator

back to summary

public void setDocumentLocator(Locator l)

Overrides org.xml.sax.helpers.DefaultHandler.setDocumentLocator.

Implements org.xml.sax.ContentHandler.setDocumentLocator.

Doc from org.xml.sax.helpers.DefaultHandler.setDocumentLocator.

Receive a Locator object for document events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.

Parameters

l:Locator: A locator for all SAX document events.

shouldIgnoreForElementPath	back to summary
protected boolean shouldIgnoreForElementPath(String tagName)

startDocument	back to summary
public void startDocument() Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Doc from org.xml.sax.helpers.DefaultHandler.startDocument. Receive notification of the beginning of the document. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).

startDocument

back to summary

public void startDocument()

Overrides org.xml.sax.helpers.DefaultHandler.startDocument.

Implements org.xml.sax.ContentHandler.startDocument.

Doc from org.xml.sax.helpers.DefaultHandler.startDocument.

Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).

startElement	back to summary
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Doc from org.xml.sax.helpers.DefaultHandler.startElement. Receive notification of the start of an element. By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file). Parameters namespaceURI:String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. localName:String The local name (without prefix), or the empty string if Namespace processing is not being performed. qName:String The qualified name (with prefix), or the empty string if qualified names are not available. atts:Attributes The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

startElement

back to summary

public void startElement(String namespaceURI, String localName, String qName, Attributes atts)

Overrides org.xml.sax.helpers.DefaultHandler.startElement.

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.helpers.DefaultHandler.startElement.

Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Parameters

namespaceURI:String: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName:String: The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName:String: The qualified name (with prefix), or the empty string if qualified names are not available.
atts:Attributes: The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

warning	back to summary
public void warning(SAXParseException spe) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.warning. Implements org.xml.sax.ErrorHandler.warning. Doc from org.xml.sax.helpers.DefaultHandler.warning. Receive notification of a parser warning. The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console. Parameters spe:SAXParseException The warning information encoded as an exception. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

warning

back to summary

public void warning(SAXParseException spe) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.warning.

Implements org.xml.sax.ErrorHandler.warning.

Doc from org.xml.sax.helpers.DefaultHandler.warning.

Receive notification of a parser warning.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.

Parameters

spe:SAXParseException: The warning information encoded as an exception.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

public Class SaxEventRecorder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail