Modifier and Type	Class and Description
private static class	XMLHelper.DocHelperErrorHandler
private static interface	XMLHelper.SecurityFeature
private static interface	XMLHelper.SecurityProperty

Field Summary

Modifier and Type	Field and Description
private static final DocumentBuilderFactory	documentBuilderFactory
pack-priv static final String	FEATURE_DISALLOW_DOCTYPE_DECL
pack-priv static final String	FEATURE_EXTERNAL_ENTITIES
pack-priv static final String	FEATURE_LOAD_DTD_GRAMMAR
pack-priv static final String	FEATURE_LOAD_EXTERNAL_DTD
pack-priv static final String	FEATURE_PARAMETER_ENTITIES
private static long	lastLog
private static final Logger	LOG
pack-priv static final String	METHOD_ENTITY_EXPANSION_XERCES
pack-priv static final String	PROPERTY_ENTITY_EXPANSION_LIMIT
pack-priv static final String	PROPERTY_SECURITY_MANAGER
private static final SAXParserFactory	saxFactory
pack-priv static final String[]	SECURITY_MANAGERS

Constructor Summary

Access	Constructor and Description
private	XMLHelper()

Method Summary

Modifier and Type	Method and Description
public static DocumentBuilderFactory	getDocumentBuilderFactory() Creates a new DocumentBuilderFactory, with sensible defaults
public static SAXParserFactory	getSaxParserFactory()
public static SchemaFactory	getSchemaFactory()
public static TransformerFactory	getTransformerFactory()
private static Object	getXercesSecurityManager()
private static InputSource	ignoreEntity(String publicId, String systemId)
private static void	logThrowable(Throwable t, String message, String name)
public static DocumentBuilder	newDocumentBuilder() Creates a new document builder, with sensible defaults
public static Transformer	newTransformer()
public static XMLEventFactory	newXMLEventFactory() Creates a new StAX XMLEventFactory, with sensible defaults
public static XMLInputFactory	newXMLInputFactory() Creates a new StAX XMLInputFactory, with sensible defaults
public static XMLOutputFactory	newXMLOutputFactory() Creates a new StAX XMLOutputFactory, with sensible defaults
public static XMLReader	newXMLReader() Creates a new SAX XMLReader, with sensible defaults
private static boolean	quietSet(XMLHelper.SecurityProperty property, String name, Object value)
private static boolean	trySet(XMLHelper.SecurityFeature feature, String name, boolean value)
private static boolean	trySet(XMLHelper.SecurityProperty property, String name, Object value)

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

Field Detail

documentBuilderFactory	back to summary
private static final DocumentBuilderFactory documentBuilderFactory

FEATURE_DISALLOW_DOCTYPE_DECL	back to summary
pack-priv static final String FEATURE_DISALLOW_DOCTYPE_DECL

FEATURE_EXTERNAL_ENTITIES	back to summary
pack-priv static final String FEATURE_EXTERNAL_ENTITIES

FEATURE_LOAD_DTD_GRAMMAR	back to summary
pack-priv static final String FEATURE_LOAD_DTD_GRAMMAR

FEATURE_LOAD_EXTERNAL_DTD	back to summary
pack-priv static final String FEATURE_LOAD_EXTERNAL_DTD

FEATURE_PARAMETER_ENTITIES	back to summary
pack-priv static final String FEATURE_PARAMETER_ENTITIES

lastLog	back to summary
private static long lastLog

LOG	back to summary
private static final Logger LOG

METHOD_ENTITY_EXPANSION_XERCES	back to summary
pack-priv static final String METHOD_ENTITY_EXPANSION_XERCES

PROPERTY_ENTITY_EXPANSION_LIMIT	back to summary
pack-priv static final String PROPERTY_ENTITY_EXPANSION_LIMIT

PROPERTY_SECURITY_MANAGER	back to summary
pack-priv static final String PROPERTY_SECURITY_MANAGER

saxFactory	back to summary
private static final SAXParserFactory saxFactory

SECURITY_MANAGERS	back to summary
pack-priv static final String[] SECURITY_MANAGERS

Constructor Detail

XMLHelper	back to summary
private XMLHelper()

Method Detail

getDocumentBuilderFactory	back to summary
public static DocumentBuilderFactory getDocumentBuilderFactory() Creates a new DocumentBuilderFactory, with sensible defaults Annotations @SuppressWarnings:squid:S2755

getDocumentBuilderFactory

back to summary

public static DocumentBuilderFactory getDocumentBuilderFactory()

Creates a new DocumentBuilderFactory, with sensible defaults

Annotations

@SuppressWarnings:squid:S2755

getSaxParserFactory	back to summary
public static SAXParserFactory getSaxParserFactory() Annotations @SuppressWarnings:squid:S2755

getSchemaFactory	back to summary
public static SchemaFactory getSchemaFactory() Annotations @SuppressWarnings:java:S2755

getTransformerFactory	back to summary
public static TransformerFactory getTransformerFactory() Annotations @SuppressWarnings:squid:S4435, java:S2755

getXercesSecurityManager	back to summary
private static Object getXercesSecurityManager()

ignoreEntity	back to summary
private static InputSource ignoreEntity(String publicId, String systemId)

logThrowable	back to summary
private static void logThrowable(Throwable t, String message, String name)

newDocumentBuilder back to summary

newDocumentBuilder	back to summary
public static DocumentBuilder newDocumentBuilder() Creates a new document builder, with sensible defaults Exceptions IllegalStateException: If creating the DocumentBuilder fails, e.g. due to `ParserConfigurationException`.

public static DocumentBuilder newDocumentBuilder()

Creates a new document builder, with sensible defaults

Exceptions

IllegalStateException:: If creating the DocumentBuilder fails, e.g. due to ParserConfigurationException.

newTransformer	back to summary
public static Transformer newTransformer() throws TransformerConfigurationException

newXMLEventFactory	back to summary
public static XMLEventFactory newXMLEventFactory() Creates a new StAX XMLEventFactory, with sensible defaults

newXMLInputFactory	back to summary
public static XMLInputFactory newXMLInputFactory() Creates a new StAX XMLInputFactory, with sensible defaults Annotations @SuppressWarnings:squid:S2755

newXMLInputFactory

back to summary

public static XMLInputFactory newXMLInputFactory()

Creates a new StAX XMLInputFactory, with sensible defaults

Annotations

@SuppressWarnings:squid:S2755

newXMLOutputFactory	back to summary
public static XMLOutputFactory newXMLOutputFactory() Creates a new StAX XMLOutputFactory, with sensible defaults

newXMLReader	back to summary
public static XMLReader newXMLReader() throws SAXException, ParserConfigurationException Creates a new SAX XMLReader, with sensible defaults

quietSet	back to summary
private static boolean quietSet(XMLHelper.SecurityProperty property, String name, Object value)

trySet	back to summary
private static boolean trySet(XMLHelper.SecurityFeature feature, String name, boolean value) Annotations @SuppressWarnings:UnusedReturnValue

trySet	back to summary
private static boolean trySet(XMLHelper.SecurityProperty property, String name, Object value)

org.apache.poi.util back to summary

private Class XMLHelper.DocHelperErrorHandler

Class Inheritance

extends Object
implements ErrorHandler

java.lang.Object
org.apache.poi.util.XMLHelper.DocHelperErrorHandler

All Implemented Interfaces

org.xml.sax.ErrorHandler

Field Summary

Modifier and Type	Field and Description
private final boolean	logException

Constructor Summary

Access	Constructor and Description
public	DocHelperErrorHandler(boolean logException)

Method Summary

Modifier and Type	Method and Description
public void	error(SAXParseException The error information encapsulated in a SAX parse exception. exception) Implements org.xml.sax.ErrorHandler.error. Receive notification of a recoverable error.
public void	fatalError(SAXParseException The error information encapsulated in a `SAXParseException`. exception) Implements org.xml.sax.ErrorHandler.fatalError. Receive notification of a non-recoverable, fatal error.
private void	printError(Level type, SAXParseException ex) Prints the error message.
public void	warning(SAXParseException The warning information encapsulated in a SAX parse exception. exception) Implements org.xml.sax.ErrorHandler.warning. Receive notification of a warning.

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

Field Detail

logException	back to summary
private final boolean logException

Constructor Detail

DocHelperErrorHandler	back to summary
public DocHelperErrorHandler(boolean logException)

Method Detail

error	back to summary
public void error(SAXParseException exception) Implements org.xml.sax.ErrorHandler.error. Doc from org.xml.sax.ErrorHandler.error. Receive notification of a recoverable error. This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action. The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so. Filters may use this method to report other, non-XML errors as well. Parameters exception:SAXParseException The error information encapsulated in a SAX parse exception.

error

back to summary

public void error(SAXParseException exception)

Implements org.xml.sax.ErrorHandler.error.

Doc from org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.

This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Parameters

exception:SAXParseException: The error information encapsulated in a SAX parse exception.

fatalError back to summary

fatalError	back to summary
public void fatalError(SAXParseException exception) throws SAXException Implements org.xml.sax.ErrorHandler.fatalError. Doc from org.xml.sax.ErrorHandler.fatalError. Receive notification of a non-recoverable, fatal error. As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation. Parameters exception:SAXParseException The error information encapsulated in a `SAXParseException`. Exceptions SAXException: if the application chooses to discontinue the parsing

public void fatalError(SAXParseException exception) throws SAXException

Implements org.xml.sax.ErrorHandler.fatalError.

Doc from org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.

As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation.

Parameters

exception:SAXParseException: The error information encapsulated in a SAXParseException.

Exceptions

SAXException:: if the application chooses to discontinue the parsing

printError	back to summary
private void printError(Level type, SAXParseException ex) Prints the error message.

warning	back to summary
public void warning(SAXParseException exception) Implements org.xml.sax.ErrorHandler.warning. Doc from org.xml.sax.ErrorHandler.warning. Receive notification of a warning. SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action. The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. Filters may use this method to report other, non-XML warnings as well. Parameters exception:SAXParseException The warning information encapsulated in a SAX parse exception.

warning

back to summary

public void warning(SAXParseException exception)

Implements org.xml.sax.ErrorHandler.warning.

Doc from org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.

SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.

Filters may use this method to report other, non-XML warnings as well.

Parameters

exception:SAXParseException: The warning information encapsulated in a SAX parse exception.

public final Class XMLHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class XMLHelper.DocHelperErrorHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface XMLHelper.SecurityFeature

Method Summary

Method Detail

private Interface XMLHelper.SecurityProperty

Method Summary

Method Detail