JAXB OSGI 4.0.9 · org.glassfish.jaxb.core.unmarshaller.DOMScanner

Modifier and Type	Field and Description
private final AttributesImpl	atts To save memory, only one instance of AttributesImpl will be used.
private Node	currentNode reference to the current node being scanned - used for determining location info for validation events
private Locator	locator
private ContentHandler	receiver This handler will receive SAX2 events.

Access	Constructor and Description
public	DOMScanner()

Method Summary

Modifier and Type	Method and Description
private void	buildNamespaceSupport(NamespaceSupport nss, Node node) Recursively visit ancestors and build up `NamespaceSupport` oject.
public int	getColumnNumber() Implements org.xml.sax.Locator.getColumnNumber. Return the column number where the current document event ends.
public ContentHandler	getContentHandler() Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getContentHandler.
public Node	getCurrentElement() Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getCurrentElement. Gets the current element we are parsing.
public Node	getCurrentLocation() The same as `getCurrentElement()` but better typed.
public int	getLineNumber() Implements org.xml.sax.Locator.getLineNumber. Return the line number where the current document event ends.
public ValidationEventLocator	getLocation() Implements org.glassfish.jaxb.core.v2.runtime.unmarshaller.LocatorEx.getLocation. Gets the current location in a `ValidationEventLocator` object.
public LocatorEx	getLocator() Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getLocator.
public String	getPublicId() Implements org.xml.sax.Locator.getPublicId. Return the public identifier for the current document event.
public String	getSystemId() Implements org.xml.sax.Locator.getSystemId. Return the system identifier for the current document event.
public void	parse(Element e, ContentHandler handler) Deprecated for removal since 2.0. in JAXB 2.0 Use `scan(Element)` Parses a subtree starting from the element e and reports SAX2 events to the specified handler.
public void	parseWithContext(Element e, ContentHandler handler) Deprecated for removal since 2.0. in JAXB 2.0 Use `scan(Element)` Similar to the parse method but it visits the ancestor nodes and properly emulate the all in-scope namespace declarations.
public void	scan(Node node) Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Parses the given DOM-ish element/document and generates SAX events.
public void	scan(Document doc) Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Parses the given DOM-ish element/document and generates SAX events.
public void	scan(Element e) Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Parses the given DOM-ish element/document and generates SAX events.
public void	setContentHandler(ContentHandler handler) Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.setContentHandler. Sets the `ContentHandler`.
private void	setCurrentLocation(Node currNode)
public void	setLocator(Locator loc) Configures the locator object that the SAX `ContentHandler` will see.
public void	visit(Element element) Visits an element and its subtree.
private Element	visit(Node n)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

atts	back to summary
private final AttributesImpl atts To save memory, only one instance of AttributesImpl will be used.

currentNode	back to summary
private Node currentNode reference to the current node being scanned - used for determining location info for validation events

locator	back to summary
private Locator locator

receiver	back to summary
private ContentHandler receiver This handler will receive SAX2 events.

DOMScanner	back to summary
public DOMScanner()

Method Detail

buildNamespaceSupport	back to summary
private void buildNamespaceSupport(NamespaceSupport nss, Node node) Recursively visit ancestors and build up `NamespaceSupport` oject.

getColumnNumber back to summary

getColumnNumber	back to summary
public int getColumnNumber() Implements org.xml.sax.Locator.getColumnNumber. Doc from org.xml.sax.Locator.getColumnNumber. Return the column number where the current document event ends. This is one-based number of Java `char` values since the last line end. Warning The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display. The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears. If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1. Annotations @Override

public int getColumnNumber()

Implements org.xml.sax.Locator.getColumnNumber.

Doc from org.xml.sax.Locator.getColumnNumber.

Return the column number where the current document event ends. This is one-based number of Java char values since the last line end.

Warning

The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

Annotations

@Override

getContentHandler	back to summary
public ContentHandler getContentHandler() Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getContentHandler. Annotations @Override

getContentHandler

back to summary

public ContentHandler getContentHandler()

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getContentHandler.

Annotations

@Override

getCurrentElement back to summary

getCurrentElement	back to summary
public Node getCurrentElement() Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getCurrentElement. Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getCurrentElement. Gets the current element we are parsing. This method could be called from the `ContentHandler#startElement(String, String, String, Attributes)` or `ContentHandler#endElement(String, String, String)`. Otherwise the behavior of this method is undefined. Annotations @Override

public Node getCurrentElement()

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getCurrentElement.

Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getCurrentElement.

Gets the current element we are parsing.

This method could be called from the ContentHandler#startElement(String, String, String, Attributes) or ContentHandler#endElement(String, String, String).

Otherwise the behavior of this method is undefined.

Annotations

@Override

getCurrentLocation	back to summary
public Node getCurrentLocation() The same as `getCurrentElement()` but better typed.

getLineNumber	back to summary
public int getLineNumber() Implements org.xml.sax.Locator.getLineNumber. Doc from org.xml.sax.Locator.getLineNumber. Return the line number where the current document event ends. Lines are delimited by line ends, which are defined in the XML specification. Warning The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these "line" numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion. The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears. If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line is line 1. Annotations @Override

getLineNumber

back to summary

public int getLineNumber()

Implements org.xml.sax.Locator.getLineNumber.

Doc from org.xml.sax.Locator.getLineNumber.

Return the line number where the current document event ends. Lines are delimited by line ends, which are defined in the XML specification.

Warning

The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these "line" numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line is line 1.

Annotations

@Override

getLocation back to summary

getLocation	back to summary
public ValidationEventLocator getLocation() Implements org.glassfish.jaxb.core.v2.runtime.unmarshaller.LocatorEx.getLocation. Doc from org.glassfish.jaxb.core.v2.runtime.unmarshaller.LocatorEx.getLocation. Gets the current location in a `ValidationEventLocator` object. Annotations @Override

public ValidationEventLocator getLocation()

Implements org.glassfish.jaxb.core.v2.runtime.unmarshaller.LocatorEx.getLocation.

Doc from org.glassfish.jaxb.core.v2.runtime.unmarshaller.LocatorEx.getLocation.

Gets the current location in a ValidationEventLocator object.

Annotations

@Override

getLocator	back to summary
public LocatorEx getLocator() Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getLocator. Annotations @Override

getLocator

back to summary

public LocatorEx getLocator()

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.getLocator.

Annotations

@Override

getPublicId	back to summary
public String getPublicId() Implements org.xml.sax.Locator.getPublicId. Doc from org.xml.sax.Locator.getPublicId. Return the public identifier for the current document event. The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears. Annotations @Override

getPublicId

back to summary

public String getPublicId()

Implements org.xml.sax.Locator.getPublicId.

Doc from org.xml.sax.Locator.getPublicId.

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

Annotations

@Override

getSystemId	back to summary
public String getSystemId() Implements org.xml.sax.Locator.getSystemId. Doc from org.xml.sax.Locator.getSystemId. Return the system identifier for the current document event. The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears. If the system identifier is a URL, the parser must resolve it fully before passing it to the application. For example, a file name must always be provided as a file:... URL, and other kinds of relative URI are also resolved against their bases. Annotations @Override

getSystemId

back to summary

public String getSystemId()

Implements org.xml.sax.Locator.getSystemId.

Doc from org.xml.sax.Locator.getSystemId.

Return the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application. For example, a file name must always be provided as a file:... URL, and other kinds of relative URI are also resolved against their bases.

Annotations

@Override

parse back to summary

parse	back to summary
public void parse(Element e, ContentHandler handler) throws SAXException Deprecated for removal since 2.0. in JAXB 2.0 Use `scan(Element)` Parses a subtree starting from the element e and reports SAX2 events to the specified handler. Annotations @Deprecated since:2.0 forRemoval:true

public void parse(Element e, ContentHandler handler) throws SAXException

Deprecated

for removal since 2.0.

in JAXB 2.0 Use scan(Element)

Parses a subtree starting from the element e and reports SAX2 events to the specified handler.

Annotations

@Deprecated
since:2.0
forRemoval:true

parseWithContext back to summary

parseWithContext	back to summary
public void parseWithContext(Element e, ContentHandler handler) throws SAXException Deprecated for removal since 2.0. in JAXB 2.0 Use `scan(Element)` Similar to the parse method but it visits the ancestor nodes and properly emulate the all in-scope namespace declarations. Annotations @Deprecated since:2.0 forRemoval:true

public void parseWithContext(Element e, ContentHandler handler) throws SAXException

Deprecated

for removal since 2.0.

in JAXB 2.0 Use scan(Element)

Similar to the parse method but it visits the ancestor nodes and properly emulate the all in-scope namespace declarations.

Annotations

@Deprecated
since:2.0
forRemoval:true

scan back to summary

scan	back to summary
public void scan(Node node) throws SAXException Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Parses the given DOM-ish element/document and generates SAX events. Annotations @Override Exceptions SAXException: If the `ContentHandler` throws a `SAXException`. Do not throw an exception just because the scanner failed (if that can happen we need to change the API.)

public void scan(Node node) throws SAXException

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan.

Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan.

Parses the given DOM-ish element/document and generates SAX events.

Annotations

@Override

Exceptions

SAXException:: If the ContentHandler throws a SAXException. Do not throw an exception just because the scanner failed (if that can happen we need to change the API.)

scan back to summary

scan	back to summary
public void scan(Document doc) throws SAXException Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Parses the given DOM-ish element/document and generates SAX events. Exceptions SAXException: If the `ContentHandler` throws a `SAXException`. Do not throw an exception just because the scanner failed (if that can happen we need to change the API.)

public void scan(Document doc) throws SAXException

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan.

Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan.

Parses the given DOM-ish element/document and generates SAX events.

Exceptions

SAXException:: If the ContentHandler throws a SAXException. Do not throw an exception just because the scanner failed (if that can happen we need to change the API.)

scan back to summary

scan	back to summary
public void scan(Element e) throws SAXException Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan. Parses the given DOM-ish element/document and generates SAX events. Exceptions SAXException: If the `ContentHandler` throws a `SAXException`. Do not throw an exception just because the scanner failed (if that can happen we need to change the API.)

public void scan(Element e) throws SAXException

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan.

Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.scan.

Parses the given DOM-ish element/document and generates SAX events.

Exceptions

SAXException:: If the ContentHandler throws a SAXException. Do not throw an exception just because the scanner failed (if that can happen we need to change the API.)

setContentHandler back to summary

setContentHandler	back to summary
public void setContentHandler(ContentHandler handler) Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.setContentHandler. Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.setContentHandler. Sets the `ContentHandler`. This handler receives the SAX events. Annotations @Override

public void setContentHandler(ContentHandler handler)

Implements org.glassfish.jaxb.core.unmarshaller.InfosetScanner.setContentHandler.

Doc from org.glassfish.jaxb.core.unmarshaller.InfosetScanner.setContentHandler.

Sets the ContentHandler. This handler receives the SAX events.

Annotations

@Override

setCurrentLocation	back to summary
private void setCurrentLocation(Node currNode)

setLocator	back to summary
public void setLocator(Locator loc) Configures the locator object that the SAX `ContentHandler` will see.

visit	back to summary
public void visit(Element element) throws SAXException Visits an element and its subtree.

visit	back to summary
private Element visit(Node n) throws SAXException

public Class DOMScanner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail