Spring Framework 6.1.4 · org.springframework.util.xml.StaxStreamHandler

Modifier and Type	Field and Description
private final XMLStreamWriter	streamWriter

Access	Constructor and Description
public	StaxStreamHandler(XMLStreamWriter streamWriter)

Modifier and Type	Method and Description
protected void	cDataInternal(String data) Implements abstract org.springframework.util.xml.AbstractStaxHandler.cDataInternal.
protected void	charactersInternal(String data) Implements abstract org.springframework.util.xml.AbstractStaxHandler.charactersInternal.
protected void	commentInternal(String comment) Implements abstract org.springframework.util.xml.AbstractStaxHandler.commentInternal.
protected void	dtdInternal(String dtd) Implements abstract org.springframework.util.xml.AbstractStaxHandler.dtdInternal.
protected void	endDocumentInternal() Implements abstract org.springframework.util.xml.AbstractStaxHandler.endDocumentInternal.
protected void	endElementInternal(QName name, Map<String, String> namespaceMapping) Implements abstract org.springframework.util.xml.AbstractStaxHandler.endElementInternal.
public void	endEntity(String The name of the entity that is ending. name) Overrides org.springframework.util.xml.AbstractStaxHandler.endEntity. Implements org.xml.sax.ext.LexicalHandler.endEntity. Report the end of an entity.
protected void	ignorableWhitespaceInternal(String data) Implements abstract org.springframework.util.xml.AbstractStaxHandler.ignorableWhitespaceInternal.
protected void	processingInstructionInternal(String target, String data) Implements abstract org.springframework.util.xml.AbstractStaxHandler.processingInstructionInternal.
public void	setDocumentLocator(Locator an object that can return the location of any SAX document event locator) Implements org.xml.sax.ContentHandler.setDocumentLocator. Receive an object for locating the origin of SAX document events.
protected void	skippedEntityInternal(String name) Implements abstract org.springframework.util.xml.AbstractStaxHandler.skippedEntityInternal.
protected void	startDocumentInternal() Implements abstract org.springframework.util.xml.AbstractStaxHandler.startDocumentInternal.
protected void	startElementInternal(QName name, Attributes attributes, Map<String, String> namespaceMapping) Implements abstract org.springframework.util.xml.AbstractStaxHandler.startElementInternal.
public void	startEntity(String The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]". name) Overrides org.springframework.util.xml.AbstractStaxHandler.startEntity. Implements org.xml.sax.ext.LexicalHandler.startEntity. Report the beginning of some internal and external XML entities.

streamWriter	back to summary
private final XMLStreamWriter streamWriter

StaxStreamHandler	back to summary
public StaxStreamHandler(XMLStreamWriter streamWriter)

Method Detail

cDataInternal	back to summary
protected void cDataInternal(String data) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.cDataInternal. Annotations @Override

cDataInternal

back to summary

protected void cDataInternal(String data) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.cDataInternal.

Annotations

@Override

charactersInternal	back to summary
protected void charactersInternal(String data) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.charactersInternal. Annotations @Override

charactersInternal

back to summary

protected void charactersInternal(String data) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.charactersInternal.

Annotations

@Override

commentInternal	back to summary
protected void commentInternal(String comment) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.commentInternal. Annotations @Override

commentInternal

back to summary

protected void commentInternal(String comment) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.commentInternal.

Annotations

@Override

dtdInternal	back to summary
protected void dtdInternal(String dtd) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.dtdInternal. Annotations @Override

dtdInternal

back to summary

protected void dtdInternal(String dtd) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.dtdInternal.

Annotations

@Override

endDocumentInternal	back to summary
protected void endDocumentInternal() throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.endDocumentInternal. Annotations @Override

endDocumentInternal

back to summary

protected void endDocumentInternal() throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.endDocumentInternal.

Annotations

@Override

endElementInternal	back to summary
protected void endElementInternal(QName name, Map<String, String> namespaceMapping) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.endElementInternal. Annotations @Override

endElementInternal

back to summary

protected void endElementInternal(QName name, Map<String, String> namespaceMapping) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.endElementInternal.

Annotations

@Override

endEntity	back to summary
public void endEntity(String name) throws SAXException Overrides org.springframework.util.xml.AbstractStaxHandler.endEntity. Implements org.xml.sax.ext.LexicalHandler.endEntity. Doc from org.xml.sax.ext.LexicalHandler.endEntity. Report the end of an entity. Parameters name:String The name of the entity that is ending. Annotations @Override Exceptions SAXException: The application may raise an exception.

endEntity

back to summary

public void endEntity(String name) throws SAXException

Overrides org.springframework.util.xml.AbstractStaxHandler.endEntity.

Implements org.xml.sax.ext.LexicalHandler.endEntity.

Doc from org.xml.sax.ext.LexicalHandler.endEntity.

Report the end of an entity.

Parameters

name:String: The name of the entity that is ending.

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

ignorableWhitespaceInternal	back to summary
protected void ignorableWhitespaceInternal(String data) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.ignorableWhitespaceInternal. Annotations @Override

ignorableWhitespaceInternal

back to summary

protected void ignorableWhitespaceInternal(String data) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.ignorableWhitespaceInternal.

Annotations

@Override

processingInstructionInternal	back to summary
protected void processingInstructionInternal(String target, String data) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.processingInstructionInternal. Annotations @Override

processingInstructionInternal

back to summary

protected void processingInstructionInternal(String target, String data) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.processingInstructionInternal.

Annotations

@Override

setDocumentLocator back to summary

setDocumentLocator	back to summary
public void setDocumentLocator(Locator locator) Implements org.xml.sax.ContentHandler.setDocumentLocator. Doc from org.xml.sax.ContentHandler.setDocumentLocator. Receive an object for locating the origin of SAX document events. SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface. The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine. Note that the locator will return correct information only during the invocation SAX event callbacks after `startDocument` returns and before `endDocument` is called. The application should not attempt to use it at any other time. Parameters locator:Locator an object that can return the location of any SAX document event Annotations @Override

public void setDocumentLocator(Locator locator)

Implements org.xml.sax.ContentHandler.setDocumentLocator.

Doc from org.xml.sax.ContentHandler.setDocumentLocator.

Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation SAX event callbacks after startDocument returns and before endDocument is called. The application should not attempt to use it at any other time.

Parameters

locator:Locator: an object that can return the location of any SAX document event

Annotations

@Override

skippedEntityInternal	back to summary
protected void skippedEntityInternal(String name) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.skippedEntityInternal. Annotations @Override

skippedEntityInternal

back to summary

protected void skippedEntityInternal(String name) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.skippedEntityInternal.

Annotations

@Override

startDocumentInternal	back to summary
protected void startDocumentInternal() throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.startDocumentInternal. Annotations @Override

startDocumentInternal

back to summary

protected void startDocumentInternal() throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.startDocumentInternal.

Annotations

@Override

startElementInternal	back to summary
protected void startElementInternal(QName name, Attributes attributes, Map<String, String> namespaceMapping) throws XMLStreamException Implements abstract org.springframework.util.xml.AbstractStaxHandler.startElementInternal. Annotations @Override

startElementInternal

back to summary

protected void startElementInternal(QName name, Attributes attributes, Map<String, String> namespaceMapping) throws XMLStreamException

Implements abstract org.springframework.util.xml.AbstractStaxHandler.startElementInternal.

Annotations

@Override

startEntity back to summary

startEntity	back to summary
public void startEntity(String name) throws SAXException Overrides org.springframework.util.xml.AbstractStaxHandler.startEntity. Implements org.xml.sax.ext.LexicalHandler.startEntity. Doc from org.xml.sax.ext.LexicalHandler.startEntity. Report the beginning of some internal and external XML entities. The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the `http://xml.org/sax/features/lexical-handler/parameter-entities` feature to query or control the reporting of parameter entities. General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]". When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from `DeclHandler` or `DTDHandler` be properly ordered. Note that skipped entities will be reported through the `skippedEntity` event, which is part of the ContentHandler interface. Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances: general entities within attribute values parameter entities within declarations These will be silently expanded, with no indication of where the original entity boundaries were. Note also that the boundaries of character references (which are not really entities anyway) are not reported. All start/endEntity events must be properly nested. Parameters name:String The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]". Annotations @Override Exceptions SAXException: The application may raise an exception.

public void startEntity(String name) throws SAXException

Overrides org.springframework.util.xml.AbstractStaxHandler.startEntity.

Implements org.xml.sax.ext.LexicalHandler.startEntity.

Doc from org.xml.sax.ext.LexicalHandler.startEntity.

Report the beginning of some internal and external XML entities.

The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the http://xml.org/sax/features/lexical-handler/parameter-entities feature to query or control the reporting of parameter entities.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from DeclHandler or DTDHandler be properly ordered.

Note that skipped entities will be reported through the skippedEntity event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

general entities within attribute values
parameter entities within declarations

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Parameters

name:String: The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".

Annotations

@Override

Exceptions

SAXException:: The application may raise an exception.

pack-priv Class StaxStreamHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail