OpenJDK 27 · jdk.internal.util.xml.PropertiesDefaultHandler

Modifier and Type	Field and Description
pack-priv static final String	ALLOWED_COMMENT
pack-priv static final String	ALLOWED_ELEMENTS
private static final String	ATTR_KEY
pack-priv StringBuilder	buf
private static final String	ELEMENT_COMMENT
private static final String	ELEMENT_ENTRY
private static final String	ELEMENT_ROOT
private static final String	EXTERNAL_XML_VERSION Version number for the format of exported properties files.
pack-priv String	key
private Properties	properties
private static final String	PROPS_DTD
private static final String	PROPS_DTD_DECL
private static final String	PROPS_DTD_URI
pack-priv String	rootElm
pack-priv boolean	sawComment
pack-priv boolean	sawRoot
pack-priv boolean	validEntry

Access	Constructor and Description
public	PropertiesDefaultHandler()

Modifier and Type	Method and Description
public void	characters(char[] ch, int start, int length) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.characters. Implements jdk.internal.org.xml.sax.ContentHandler.characters. Receive notification of character data inside an element.
public void	endElement(String uri, String localName, String qName) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.endElement. Implements jdk.internal.org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element.
public void	error(SAXParseException x) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.error. Implements jdk.internal.org.xml.sax.ErrorHandler.error. Receive notification of a recoverable parser error.
public void	fatalError(SAXParseException x) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.fatalError. Implements jdk.internal.org.xml.sax.ErrorHandler.fatalError. Report a fatal XML parsing error.
public void	load(Properties props, InputStream in)
public InputSource	resolveEntity(String pubid, String sysid) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.resolveEntity. Implements jdk.internal.org.xml.sax.EntityResolver.resolveEntity. Resolve an external entity.
public void	startDTD(String name, String publicId, String systemId) Overrides default jdk.internal.org.xml.sax.DTDHandler.startDTD. Receive notification of the start of DTD declarations.
public void	startElement(String uri, String localName, String qName, Attributes attributes) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.startElement. Implements jdk.internal.org.xml.sax.ContentHandler.startElement. Receive notification of the start of an element.
public void	startInternalSub() Overrides default jdk.internal.org.xml.sax.DTDHandler.startInternalSub. Receive notification of the start of DTD internal subset.
public void	store(Properties props, OutputStream os, String comment, Charset charset)
public void	warning(SAXParseException x) Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.warning. Implements jdk.internal.org.xml.sax.ErrorHandler.warning. Receive notification of a parser warning.

ALLOWED_COMMENT	back to summary
pack-priv static final String ALLOWED_COMMENT

ALLOWED_ELEMENTS	back to summary
pack-priv static final String ALLOWED_ELEMENTS

ATTR_KEY	back to summary
private static final String ATTR_KEY

buf	back to summary
pack-priv StringBuilder buf

ELEMENT_COMMENT	back to summary
private static final String ELEMENT_COMMENT

ELEMENT_ENTRY	back to summary
private static final String ELEMENT_ENTRY

ELEMENT_ROOT	back to summary
private static final String ELEMENT_ROOT

EXTERNAL_XML_VERSION	back to summary
private static final String EXTERNAL_XML_VERSION Version number for the format of exported properties files.

key	back to summary
pack-priv String key

properties	back to summary
private Properties properties

PROPS_DTD	back to summary
private static final String PROPS_DTD

PROPS_DTD_DECL	back to summary
private static final String PROPS_DTD_DECL

PROPS_DTD_URI	back to summary
private static final String PROPS_DTD_URI

rootElm	back to summary
pack-priv String rootElm

sawComment	back to summary
pack-priv boolean sawComment

sawRoot	back to summary
pack-priv boolean sawRoot

validEntry	back to summary
pack-priv boolean validEntry

PropertiesDefaultHandler	back to summary
public PropertiesDefaultHandler()

Method Detail

characters	back to summary
public void characters(char[] ch, int start, int length) throws SAXException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.characters. Implements jdk.internal.org.xml.sax.ContentHandler.characters. Doc from jdk.internal.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). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

characters

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

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

Implements jdk.internal.org.xml.sax.ContentHandler.characters.

Doc from jdk.internal.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).

Annotations

@Override

Exceptions

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

endElement	back to summary
public void endElement(String uri, String localName, String qName) throws SAXException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.endElement. Implements jdk.internal.org.xml.sax.ContentHandler.endElement. Doc from jdk.internal.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). Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endElement

back to summary

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

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

Implements jdk.internal.org.xml.sax.ContentHandler.endElement.

Doc from jdk.internal.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).

Annotations

@Override

Exceptions

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

error	back to summary
public void error(SAXParseException x) throws SAXException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.error. Implements jdk.internal.org.xml.sax.ErrorHandler.error. Doc from jdk.internal.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. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

error

back to summary

public void error(SAXParseException x) throws SAXException

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

Implements jdk.internal.org.xml.sax.ErrorHandler.error.

Doc from jdk.internal.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.

Annotations

@Override

Exceptions

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

fatalError	back to summary
public void fatalError(SAXParseException x) throws SAXException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.fatalError. Implements jdk.internal.org.xml.sax.ErrorHandler.fatalError. Doc from jdk.internal.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. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

fatalError

back to summary

public void fatalError(SAXParseException x) throws SAXException

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

Implements jdk.internal.org.xml.sax.ErrorHandler.fatalError.

Doc from jdk.internal.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.

Annotations

@Override

Exceptions

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

load	back to summary
public void load(Properties props, InputStream in) throws IOException, InvalidPropertiesFormatException, UnsupportedEncodingException

resolveEntity	back to summary
public InputSource resolveEntity(String pubid, String sysid) throws SAXException, IOException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.resolveEntity. Implements jdk.internal.org.xml.sax.EntityResolver.resolveEntity. Doc from jdk.internal.org.xml.sax.helpers.DefaultHandler.resolveEntity. Resolve an external entity. Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception. IOException: If there is an error setting up the new input source.

resolveEntity

back to summary

public InputSource resolveEntity(String pubid, String sysid) throws SAXException, IOException

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

Implements jdk.internal.org.xml.sax.EntityResolver.resolveEntity.

Doc from jdk.internal.org.xml.sax.helpers.DefaultHandler.resolveEntity.

Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.
IOException:: If there is an error setting up the new input source.

startDTD	back to summary
public void startDTD(String name, String publicId, String systemId) throws SAXException Overrides default jdk.internal.org.xml.sax.DTDHandler.startDTD. Doc from jdk.internal.org.xml.sax.DTDHandler.startDTD. Receive notification of the start of DTD declarations. The start/endDTD events appear within the start/endDocument events from ContentHandler. Annotations @Override Exceptions SAXException: the event receiver may throw an exception during processing

startDTD

back to summary

public void startDTD(String name, String publicId, String systemId) throws SAXException

Overrides default jdk.internal.org.xml.sax.DTDHandler.startDTD.

Doc from jdk.internal.org.xml.sax.DTDHandler.startDTD.

Receive notification of the start of DTD declarations. The start/endDTD events appear within the start/endDocument events from ContentHandler.

Annotations

@Override

Exceptions

SAXException:: the event receiver may throw an exception during processing

startElement	back to summary
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.startElement. Implements jdk.internal.org.xml.sax.ContentHandler.startElement. Doc from jdk.internal.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). Annotations @Override Exceptions SAXException: 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 jdk.internal.org.xml.sax.helpers.DefaultHandler.startElement.

Implements jdk.internal.org.xml.sax.ContentHandler.startElement.

Doc from jdk.internal.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).

Annotations

@Override

Exceptions

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

startInternalSub	back to summary
public void startInternalSub() throws SAXException Overrides default jdk.internal.org.xml.sax.DTDHandler.startInternalSub. Doc from jdk.internal.org.xml.sax.DTDHandler.startInternalSub. Receive notification of the start of DTD internal subset. Annotations @Override Exceptions SAXException: the event receiver may throw an exception during processing

startInternalSub

back to summary

public void startInternalSub() throws SAXException

Overrides default jdk.internal.org.xml.sax.DTDHandler.startInternalSub.

Doc from jdk.internal.org.xml.sax.DTDHandler.startInternalSub.

Receive notification of the start of DTD internal subset.

Annotations

@Override

Exceptions

SAXException:: the event receiver may throw an exception during processing

store	back to summary
public void store(Properties props, OutputStream os, String comment, Charset charset) throws IOException

warning	back to summary
public void warning(SAXParseException x) throws SAXException Overrides jdk.internal.org.xml.sax.helpers.DefaultHandler.warning. Implements jdk.internal.org.xml.sax.ErrorHandler.warning. Doc from jdk.internal.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. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

warning

back to summary

public void warning(SAXParseException x) throws SAXException

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

Implements jdk.internal.org.xml.sax.ErrorHandler.warning.

Doc from jdk.internal.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.

Annotations

@Override

Exceptions

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

public Class PropertiesDefaultHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail