aalto-xml 1.3.2 · com.fasterxml.aalto.impl.CommonConfig

Field Summary

Modifier and Type	Field and Description
protected int	_flagMods Bitset that indicates all explicit changes to on/off values; clear bits indicate settings that are unmodified default values.
protected int	_flags Bitset for all on/off values for this configuration object.
protected static final String	IMPL_NAME
protected static final String	IMPL_VERSION This is "major.minor" version used for purposes of determining the feature set.
pack-priv static final int	PROP_IMPL_NAME
pack-priv static final int	PROP_IMPL_VERSION
pack-priv static final int	PROP_SUPPORTS_XML11
pack-priv static final int	PROP_SUPPORTS_XMLID
pack-priv static final HashMap<String, Integer>	sStdProperties Map to use for converting from String property ids to enumeration (ints).

Constructor Summary

Access	Constructor and Description
protected	CommonConfig(int flags, int flagMods)

Method Summary

Modifier and Type	Method and Description
public abstract String	Returns: Actual encoding in use, as determined by the processor. getActualEncoding()
public abstract String	Returns: Encoding that has been passed externally by the application getExternalEncoding() This method returns name of encoding that has been passed explicitly to the reader or writer, from outside.
public Object	getProperty(String propName, boolean If true, unrecognized property should result in `IllegalArgumentException` isMandatory)
protected final boolean	hasExplicitFlag(int flagMask)
protected final boolean	hasFlag(int flagMask)
protected final boolean	Returns: False, if flag in question has its default value, true if a call has been made that could have changed it. hasFlagBeenModified(int flagMask) Method for checking whether specific configuration flag has been explicitly modified (set, clear; regardless of whether state actually changed), or is it the default value.
public boolean	isPropertySupported(String propName)
public abstract boolean	Returns: True, if the processing will be done according to Xml 1.1 rules; false if according to xml 1.0 isXml11()
protected final void	setFlag(int flagMask, boolean state)
public boolean	Returns: True, if the specified property was succesfully set to specified value; false if its value was not changed setProperty(String propName, Object value)

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

Field Detail

_flagMods	back to summary
protected int _flagMods Bitset that indicates all explicit changes to on/off values; clear bits indicate settings that are unmodified default values.

_flags	back to summary
protected int _flags Bitset for all on/off values for this configuration object.

IMPL_NAME	back to summary
protected static final String IMPL_NAME

IMPL_VERSION	back to summary
protected static final String IMPL_VERSION This is "major.minor" version used for purposes of determining the feature set. Patch level is not included, since those should not affect API or feature set. Using applications should be prepared to take additional levels, however, just not depend on those being available.

PROP_IMPL_NAME	back to summary
pack-priv static final int PROP_IMPL_NAME

PROP_IMPL_VERSION	back to summary
pack-priv static final int PROP_IMPL_VERSION

PROP_SUPPORTS_XML11	back to summary
pack-priv static final int PROP_SUPPORTS_XML11

PROP_SUPPORTS_XMLID	back to summary
pack-priv static final int PROP_SUPPORTS_XMLID

sStdProperties	back to summary
pack-priv static final HashMap<String, Integer> sStdProperties Map to use for converting from String property ids to enumeration (ints). Used for faster dispatching.

Constructor Detail

CommonConfig	back to summary
protected CommonConfig(int flags, int flagMods)

Method Detail

getActualEncoding	back to summary
public abstract String getActualEncoding() Returns:String Actual encoding in use, as determined by the processor.

getExternalEncoding	back to summary
public abstract String getExternalEncoding() This method returns name of encoding that has been passed explicitly to the reader or writer, from outside. An example is that HTTP server may pass encoding as declared in HTTP headers. This should either be null (if none passed), or the same as actual encoding (which is determined from physical stream contents [for readers], or from encoder properties / configuration [for writers] Returns:String Encoding that has been passed externally by the application

getExternalEncoding

back to summary

public abstract String getExternalEncoding()

This method returns name of encoding that has been passed explicitly to the reader or writer, from outside. An example is that HTTP server may pass encoding as declared in HTTP headers. This should either be null (if none passed), or the same as actual encoding (which is determined from physical stream contents [for readers], or from encoder properties / configuration [for writers]

Returns:String: Encoding that has been passed externally by the application

getProperty	back to summary
public Object getProperty(String propName, boolean isMandatory) Parameters isMandatory:boolean If true, unrecognized property should result in `IllegalArgumentException`

hasExplicitFlag	back to summary
protected final boolean hasExplicitFlag(int flagMask)

hasFlag	back to summary
protected final boolean hasFlag(int flagMask)

hasFlagBeenModified	back to summary
protected final boolean hasFlagBeenModified(int flagMask) Method for checking whether specific configuration flag has been explicitly modified (set, clear; regardless of whether state actually changed), or is it the default value. Returns:boolean False, if flag in question has its default value, true if a call has been made that could have changed it.

hasFlagBeenModified