OpenJDK 27 · com.sun.beans.decoder.DocumentHandler · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final Map<String, Object>	environment
private ElementHandler	handler
private final Map<String, Class<? extends ElementHandler>>	handlers
private ExceptionListener	listener
private Reference<ClassLoader>	loader
private final List<Object>	objects
private Object	owner

Access	Constructor and Description
public	DocumentHandler() Creates new instance of document handler.

Method Summary

Modifier and Type	Method and Description
pack-priv void	addObject(Object the object that is read from XML document object) Adds the object to the list of read objects.
public void	characters(char[] the array of characters chars, int the start position in the character array start, int the number of characters to use length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Parses character data inside XML 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 uri, 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. Parses closing tag of XML element using corresponding element handler.
public Class<?>	Returns: the object that represents the class findClass(String the name of the class name) Resolves class by name using current class loader.
public ClassLoader	Returns: the class loader used to instantiate objects getClassLoader() Returns the class loader used to instantiate objects.
public Class<? extends ElementHandler>	Returns: the corresponding element handler getElementHandler(String the name of the element name) Returns the handler for the element with specified name.
public ExceptionListener	Returns: the exception listener for parsing getExceptionListener() Returns the exception listener for parsing.
public Object[]	Returns: the array of read objects getObjects() Returns the array of read objects.
public Object	Returns: the owner of this document handler getOwner() Returns the owner of this document handler.
public Object	Returns: the value of the variable getVariable(String the identifier id) Returns the value of the variable with specified identifier.
public void	handleException(Exception an exception to handle exception) Handles an exception using current exception listener.
public boolean	Returns: `true` if the variable is defined; `false` otherwise hasVariable(String the identifier id) Indicates whether the variable with specified identifier is defined.
public void	parse(final InputSource the input source to parse input) Starts parsing of the specified input source.
public InputSource	resolveEntity(String publicId, String systemId) Overrides org.xml.sax.helpers.DefaultHandler.resolveEntity. Implements org.xml.sax.EntityResolver.resolveEntity. Disables any external entities.
public void	setClassLoader(ClassLoader a classloader to use loader) Sets the class loader used to instantiate objects.
public void	setElementHandler(String the name of the element name, Class<? extends ElementHandler> the corresponding element handler handler) Sets the handler for the element with specified name.
public void	setExceptionListener(ExceptionListener the exception listener for parsing listener) Sets the exception listener for parsing.
public void	setOwner(Object the owner of this document handler owner) Sets the owner of this document handler.
public void	setVariable(String the identifier id, Object new value of the variable value) Sets new value of the variable with specified identifier.
public void	startDocument() Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Prepares this handler to read objects from XML 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 uri, 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 attributes) Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Parses opening tag of XML element using corresponding element handler.

Inherited from org.xml.sax.helpers.DefaultHandler:: endDocument endPrefixMapping error fatalError ignorableWhitespace notationDecl processingInstruction setDocumentLocator skippedEntity startPrefixMapping unparsedEntityDecl warning

environment	back to summary
private final Map<String, Object> environment

handler	back to summary
private ElementHandler handler

handlers	back to summary
private final Map<String, Class<? extends ElementHandler>> handlers

listener	back to summary
private ExceptionListener listener

loader	back to summary
private Reference<ClassLoader> loader

objects	back to summary
private final List<Object> objects

owner	back to summary
private Object owner

DocumentHandler	back to summary
public DocumentHandler() Creates new instance of document handler.

Method Detail

addObject	back to summary
pack-priv void addObject(Object object) Adds the object to the list of read objects. Parameters object:Object the object that is read from XML document

addObject

back to summary

pack-priv void addObject(Object object)

Adds the object to the list of read objects.

Parameters

object:Object: the object that is read from XML document

characters	back to summary
public void characters(char[] chars, int start, int length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Parses character data inside XML element. Parameters chars:char[] the array of characters start:int the start position in the character array length:int the number of characters to use Annotations @Override

characters

back to summary

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

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

Implements org.xml.sax.ContentHandler.characters.

Parses character data inside XML element.

Parameters

chars:char[]: the array of characters
start:int: the start position in the character array
length:int: the number of characters to use

Annotations

@Override

endElement	back to summary
public void endElement(String uri, String localName, String qName) Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Parses closing tag of XML element using corresponding element handler. Parameters uri: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 Annotations @Override

endElement

back to summary

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

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

Implements org.xml.sax.ContentHandler.endElement.

Parses closing tag of XML element using corresponding element handler.

Parameters

uri: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

Annotations

@Override

findClass	back to summary
public Class<?> findClass(String name) Resolves class by name using current class loader. This method handles exception using current exception listener. Parameters name:String the name of the class Returns:Class<?> the object that represents the class

findClass

back to summary

public Class<?> findClass(String name)

Resolves class by name using current class loader. This method handles exception using current exception listener.

Parameters

name:String: the name of the class

Returns:Class<?>

the object that represents the class

getClassLoader back to summary

getClassLoader	back to summary
public ClassLoader getClassLoader() Returns the class loader used to instantiate objects. If the class loader has not been explicitly set then `null` is returned. Returns:ClassLoader the class loader used to instantiate objects

public ClassLoader getClassLoader()

Returns the class loader used to instantiate objects. If the class loader has not been explicitly set then null is returned.

Returns:ClassLoader: the class loader used to instantiate objects

getElementHandler	back to summary
public Class<? extends ElementHandler> getElementHandler(String name) Returns the handler for the element with specified name. Parameters name:String the name of the element Returns:Class<? extends ElementHandler> the corresponding element handler

getElementHandler

back to summary

public Class<? extends ElementHandler> getElementHandler(String name)

Returns the handler for the element with specified name.

Parameters

name:String: the name of the element

Returns:Class<? extends ElementHandler>

the corresponding element handler

getExceptionListener	back to summary
public ExceptionListener getExceptionListener() Returns the exception listener for parsing. The exception listener is notified when handler catches recoverable exceptions. If the exception listener has not been explicitly set then default exception listener is returned. Returns:ExceptionListener the exception listener for parsing

getExceptionListener

back to summary

public ExceptionListener getExceptionListener()

Returns the exception listener for parsing. The exception listener is notified when handler catches recoverable exceptions. If the exception listener has not been explicitly set then default exception listener is returned.

Returns:ExceptionListener: the exception listener for parsing

getObjects	back to summary
public Object[] getObjects() Returns the array of read objects. Returns:Object[] the array of read objects

getObjects

back to summary

public Object[] getObjects()

Returns the array of read objects.

Returns:Object[]: the array of read objects

getOwner	back to summary
public Object getOwner() Returns the owner of this document handler. Returns:Object the owner of this document handler

getOwner

back to summary

public Object getOwner()

Returns the owner of this document handler.

Returns:Object: the owner of this document handler

getVariable	back to summary
public Object getVariable(String id) Returns the value of the variable with specified identifier. Parameters id:String the identifier Returns:Object the value of the variable

getVariable

back to summary

public Object getVariable(String id)

Returns the value of the variable with specified identifier.

Parameters

id:String: the identifier

Returns:Object

the value of the variable

handleException back to summary

handleException	back to summary
public void handleException(Exception exception) Handles an exception using current exception listener. Parameters exception:Exception an exception to handle See Also `setExceptionListener`

public void handleException(Exception exception)

Handles an exception using current exception listener.

Parameters

exception:Exception: an exception to handle

See Also

setExceptionListener

hasVariable back to summary

hasVariable	back to summary
public boolean hasVariable(String id) Indicates whether the variable with specified identifier is defined. Parameters id:String the identifier Returns:boolean `true` if the variable is defined; `false` otherwise

public boolean hasVariable(String id)

Indicates whether the variable with specified identifier is defined.

Parameters

id:String: the identifier

Returns:boolean

true if the variable is defined; false otherwise

parse	back to summary
public void parse(final InputSource input) Starts parsing of the specified input source. Parameters input:InputSource the input source to parse

parse

back to summary

public void parse(final InputSource input)

Starts parsing of the specified input source.

Parameters

input:InputSource: the input source to parse

resolveEntity	back to summary
public InputSource resolveEntity(String publicId, String systemId) Overrides org.xml.sax.helpers.DefaultHandler.resolveEntity. Implements org.xml.sax.EntityResolver.resolveEntity. Disables any external entities. Annotations @Override

resolveEntity

back to summary

public InputSource resolveEntity(String publicId, String systemId)

Overrides org.xml.sax.helpers.DefaultHandler.resolveEntity.

Implements org.xml.sax.EntityResolver.resolveEntity.

Disables any external entities.

Annotations

@Override

setClassLoader	back to summary
public void setClassLoader(ClassLoader loader) Sets the class loader used to instantiate objects. If the class loader is not set then default class loader will be used. Parameters loader:ClassLoader a classloader to use

setClassLoader

back to summary

public void setClassLoader(ClassLoader loader)

Sets the class loader used to instantiate objects. If the class loader is not set then default class loader will be used.

Parameters

loader:ClassLoader: a classloader to use

setElementHandler	back to summary
public void setElementHandler(String name, Class<? extends ElementHandler> handler) Sets the handler for the element with specified name. Parameters name:String the name of the element handler:Class<? extends ElementHandler> the corresponding element handler

setElementHandler

back to summary

public void setElementHandler(String name, Class<? extends ElementHandler> handler)

Sets the handler for the element with specified name.

Parameters

name:String: the name of the element
handler:Class<? extends ElementHandler>: the corresponding element handler

setExceptionListener	back to summary
public void setExceptionListener(ExceptionListener listener) Sets the exception listener for parsing. The exception listener is notified when handler catches recoverable exceptions. Parameters listener:ExceptionListener the exception listener for parsing

setExceptionListener

back to summary

public void setExceptionListener(ExceptionListener listener)

Sets the exception listener for parsing. The exception listener is notified when handler catches recoverable exceptions.

Parameters

listener:ExceptionListener: the exception listener for parsing

setOwner	back to summary
public void setOwner(Object owner) Sets the owner of this document handler. Parameters owner:Object the owner of this document handler

setOwner

back to summary

public void setOwner(Object owner)

Sets the owner of this document handler.

Parameters

owner:Object: the owner of this document handler

setVariable	back to summary
public void setVariable(String id, Object value) Sets new value of the variable with specified identifier. Parameters id:String the identifier value:Object new value of the variable

setVariable

back to summary

public void setVariable(String id, Object value)

Sets new value of the variable with specified identifier.

Parameters

id:String: the identifier
value:Object: new value of the variable

startDocument	back to summary
public void startDocument() Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Prepares this handler to read objects from XML document. Annotations @Override

startDocument

back to summary

public void startDocument()

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

Implements org.xml.sax.ContentHandler.startDocument.

Prepares this handler to read objects from XML document.

Annotations

@Override

startElement	back to summary
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Parses opening tag of XML element using corresponding element handler. Parameters uri: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 attributes:Attributes the attributes attached to the element Annotations @Override @SuppressWarnings:deprecation Exceptions SAXException: Doc from org.xml.sax.helpers.DefaultHandler.startElement. Any SAX exception, possibly wrapping another exception.

startElement

back to summary

public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException

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

Implements org.xml.sax.ContentHandler.startElement.

Parses opening tag of XML element using corresponding element handler.

Parameters

uri: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
attributes:Attributes: the attributes attached to the element

Annotations

@Override
@SuppressWarnings:deprecation

Exceptions

SAXException:

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

Any SAX exception, possibly wrapping another exception.

public final Class DocumentHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail