Package com.helger.xml.serialize.read
Interface IBaseXMLReaderSettings
-
- All Known Subinterfaces:
IDOMReaderSettings,ISAXReaderSettings
- All Known Implementing Classes:
DOMReaderSettings,SAXReaderSettings
public interface IBaseXMLReaderSettingsBase Read-only interface for DOM and SAX reader settings.- Author:
- Philip Helger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<Throwable>>exceptionCallbacks()com.helger.commons.collection.impl.ICommonsMap<EXMLParserFeature,Boolean>getAllFeatureValues()com.helger.commons.collection.impl.ICommonsMap<EXMLParserProperty,Object>getAllPropertyValues()EntityResolvergetEntityResolver()ErrorHandlergetErrorHandler()BooleangetFeatureValue(EXMLParserFeature eFeature)Get the value of the specified parser featureLocalegetLocale()ObjectgetPropertyValue(EXMLParserProperty eProperty)Get the value of the specified parser propertybooleanhasAnyFeature()booleanhasAnyProperties()booleanrequiresNewXMLParser()Check if the current settings require a separate DOMDocumentBuilderFactory/SAXXMLReaderobject or if a pooled default object can be used.
-
-
-
Method Detail
-
hasAnyProperties
boolean hasAnyProperties()
- Returns:
trueif at least one parser property is defined
-
getPropertyValue
@Nullable Object getPropertyValue(@Nullable EXMLParserProperty eProperty)
Get the value of the specified parser property- Parameters:
eProperty- The property to use. May benull.- Returns:
nullif no such property was found.
-
getAllPropertyValues
@Nonnull @ReturnsMutableCopy com.helger.commons.collection.impl.ICommonsMap<EXMLParserProperty,Object> getAllPropertyValues()
- Returns:
- A copy of all contained parser property values. Never
null.
-
getLocale
@Nullable Locale getLocale()
- Returns:
- The locale to be used for error messages. By default it is
nulland therefore the XML parser will use the system default locale.
-
hasAnyFeature
boolean hasAnyFeature()
- Returns:
trueif at least one parser feature is defined,falseif not
-
getFeatureValue
@Nullable Boolean getFeatureValue(@Nullable EXMLParserFeature eFeature)
Get the value of the specified parser feature- Parameters:
eFeature- The feature to search. May benull.- Returns:
nullif this feature is undefined.
-
getAllFeatureValues
@Nonnull @ReturnsMutableCopy com.helger.commons.collection.impl.ICommonsMap<EXMLParserFeature,Boolean> getAllFeatureValues()
- Returns:
- A copy of all defined parser features at the associated values.
-
getErrorHandler
@Nullable ErrorHandler getErrorHandler()
- Returns:
- A special error handler to be used or
nullif no special error handler is needed.
-
getEntityResolver
@Nullable EntityResolver getEntityResolver()
- Returns:
- The special entity resolver to be used. May be
null.
-
exceptionCallbacks
@Nonnull @ReturnsMutableObject com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<Throwable>> exceptionCallbacks()
- Returns:
- A special exception handler to be used. Never
null.
-
requiresNewXMLParser
boolean requiresNewXMLParser()
Check if the current settings require a separate DOMDocumentBuilderFactory/SAXXMLReaderobject or if a pooled default object can be used.- Returns:
trueif a separate parser object is required,falseif not.
-
-