Modifier and Type	Class and Description
pack-priv static class	ReaderConfig.EncodingContext This is a simple container class that is used to encapsulate per-factory encoding-dependant information like symbol tables.

Field Summary

Modifier and Type	Field and Description
protected BufferRecycler	_currRecycler This is the actually container of the recyclable buffers.
pack-priv static final ThreadLocal<SoftReference<BufferRecycler>>	_recyclerRef This `ThreadLocal` contains a `SoftRerefence` to a `BufferRecycler` used to provide a low-cost buffer recycling between Reader instances.
public static final int	DEFAULT_CHAR_BUFFER_LEN
protected static final int	DEFAULT_FLAGS These are the default settings for XMLInputFactory.
public static final int	DEFAULT_SMALL_BUFFER_LEN
protected static final int	F_AUTO_CLOSE_INPUT
protected static final int	F_COALESCING
protected static final int	F_DTD_AWARE
protected static final int	F_DTD_VALIDATING
protected static final int	F_EXPAND_ENTITIES
protected static final int	F_INTERN_NAMES
protected static final int	F_INTERN_NS_URIS
protected static final int	F_LAZY_PARSING
protected static final int	F_NS_AWARE
protected static final int	F_PRESERVE_LOCATION
protected static final int	F_REPORT_CDATA
protected static final int	F_RETAIN_ATTRIBUTE_GENERAL_ENTITIES
private IllegalCharHandler	illegalCharHandler
private String	mActualEncoding Name of the actual encoding that input was found to be in (if any -- can't be determined if a Reader was passed in).
private final UriCanonicalizer	mCanonicalizer For efficient access by qualified name, as well as uniqueness checks, namespace URIs need to be canonicalized.
private final ReaderConfig.EncodingContext	mEncCtxt A single encoding context instance is shared between all ReaderConfig instances created for readers by an input factory.
private final String	mExtEncoding Encoding passed in as external information, possibly from source from which xml content was gained from (for example, as an HTTP header, or file metadata).
private final String	mPublicId
private XMLReporter	mReporter
private XMLResolver	mResolver
private final String	mSystemId
private String	mXmlDeclEncoding
private int	mXmlDeclStandalone
private String	mXmlDeclVersion
private static final HashMap<String, Object>	sProperties
public static final int	STANDALONE_NO
public static final int	STANDALONE_UNKNOWN
public static final int	STANDALONE_YES

Inherited from com.fasterxml.aalto.impl.CommonConfig:: _flagMods _flags IMPL_NAME IMPL_VERSION

Constructor Summary

Access	Constructor and Description
private	ReaderConfig(String publicId, String systemId, String extEnc, ReaderConfig.EncodingContext encCtxt, int flags, int flagMods, XMLReporter rep, XMLResolver res, UriCanonicalizer canonicalizer)
public	ReaderConfig()

Method Summary

Modifier and Type	Method and Description
public byte[]	allocFullBBuffer(int minSize)
public char[]	allocFullCBuffer(int minSize)
public char[]	allocMediumCBuffer(int minSize)
public char[]	allocSmallCBuffer(int minSize)
public String	canonicalizeURI(char[] buf, int uriLen)
public void	configureForConvenience() Method to call to make Reader created be as "convenient" to use as possible; ie try to avoid having to deal with some of things like segmented text chunks.
public void	configureForLowMemUsage() Method to call to minimize the memory usage of the stream/event reader; both regarding Objects created, and the temporary memory usage during parsing.
public void	configureForRoundTripping() Method to call to make Reader try to preserve as much of input formatting as possible, so that round-tripping would be as lossless as possible.
public void	configureForSpeed() Method to call to make the Reader created be as fast as possible reading documents, especially for long-running processes where caching is likely to help.
public void	configureForXmlConformance() Method to call to make Reader created conform as closely to XML standard as possible, doing all checks and transformations mandated (linefeed conversions, attr value normalizations).
public ReaderConfig	createNonShared(String publicId, String systemId, String extEnc)
private BufferRecycler	createRecycler()
public void	doAutoCloseInput(boolean state)
public void	doCoalesceText(boolean state)
public void	doParseLazily(boolean state)
public void	doPreserveLocation(boolean state)
public void	doReportCData(boolean state)
public void	doRetainAttributeGeneralEntities(boolean Whether to enable or disable property state) Method for enabling or disabling `AaltoInputProperties#P_RETAIN_ATTRIBUTE_GENERAL_ENTITIES`.
protected int	findPropertyId(String propName)
public void	freeFullBBuffer(byte[] buffer)
public void	freeFullCBuffer(char[] buffer)
public void	freeMediumCBuffer(char[] buffer)
public void	freeSmallCBuffer(char[] buffer)
public String	getActualEncoding() Implements abstract com.fasterxml.aalto.impl.CommonConfig.getActualEncoding.
public ByteBasedPNameTable	getBBSymbols()
public CharBasedPNameTable	getCBSymbols()
public XmlCharTypes	getCharTypes()
public String	getExternalEncoding() Implements abstract com.fasterxml.aalto.impl.CommonConfig.getExternalEncoding. This method returns name of encoding that has been passed explicitly to the reader or writer, from outside.
public IllegalCharHandler	getIllegalCharHandler()
public final Object	getProperty(String name, boolean If true, unrecognized property should result in `IllegalArgumentException` isMandatory) Overrides com.fasterxml.aalto.impl.CommonConfig.getProperty.
public String	getPublicId()
public String	getSystemId()
public String	getXmlDeclEncoding()
public int	getXmlDeclStandalone()
public String	getXmlDeclVersion()
public XMLReporter	getXMLReporter()
public XMLResolver	getXMLResolver()
public boolean	hasInternNamesBeenEnabled()
public boolean	hasInternNsURIsBeenEnabled()
public boolean	isPropertySupported(String propName) Overrides com.fasterxml.aalto.impl.CommonConfig.isPropertySupported.
public boolean	isXml11() Implements abstract com.fasterxml.aalto.impl.CommonConfig.isXml11.
public void	setActualEncoding(String actualEnc)
public void	setIllegalCharHandler(IllegalCharHandler illegalCharHandler)
public boolean	setProperty(String name, Object value) Overrides com.fasterxml.aalto.impl.CommonConfig.setProperty.
public void	setXmlDeclInfo(int version, String xmlDeclEnc, String standalone)
public final void	setXmlEncoding(String enc)
public void	setXMLReporter(XMLReporter r)
public void	setXMLResolver(XMLResolver r)
public final void	setXmlStandalone(Boolean b)
public final void	setXmlVersion(String version)
public void	updateBBSymbols(ByteBasedPNameTable sym)
public void	updateCBSymbols(CharBasedPNameTable sym)
public boolean	willAutoCloseInput()
public boolean	willCoalesceText()
public boolean	willExpandEntities()
public boolean	willInternNames()
public boolean	willInternNsURIs()
public boolean	willParseLazily()
public boolean	willPreserveLocation()
public boolean	willReportCData()
public boolean	Returns: Whether the property is enabled or disabled willRetainAttributeGeneralEntities() Accessor for checking configured state of `AaltoInputProperties#P_RETAIN_ATTRIBUTE_GENERAL_ENTITIES`.
public boolean	willSupportNamespaces()

Inherited from com.fasterxml.aalto.impl.CommonConfig:: hasExplicitFlag hasFlag hasFlagBeenModified setFlag

Field Detail

_currRecycler	back to summary
protected BufferRecycler _currRecycler This is the actually container of the recyclable buffers. It is obtained via ThreadLocal/SoftReference combination, if one exists, when Config instance is created. If one does not exist, it will created first time a buffer is returned.

_recyclerRef	back to summary
pack-priv static final ThreadLocal<SoftReference<BufferRecycler>> _recyclerRef This `ThreadLocal` contains a `SoftRerefence` to a `BufferRecycler` used to provide a low-cost buffer recycling between Reader instances.

DEFAULT_CHAR_BUFFER_LEN	back to summary
public static final int DEFAULT_CHAR_BUFFER_LEN

DEFAULT_FLAGS	back to summary
protected static final int DEFAULT_FLAGS These are the default settings for XMLInputFactory.

DEFAULT_SMALL_BUFFER_LEN	back to summary
public static final int DEFAULT_SMALL_BUFFER_LEN

F_AUTO_CLOSE_INPUT	back to summary
protected static final int F_AUTO_CLOSE_INPUT

F_COALESCING	back to summary
protected static final int F_COALESCING

F_DTD_AWARE	back to summary
protected static final int F_DTD_AWARE

F_DTD_VALIDATING	back to summary
protected static final int F_DTD_VALIDATING

F_EXPAND_ENTITIES	back to summary
protected static final int F_EXPAND_ENTITIES

F_INTERN_NAMES	back to summary
protected static final int F_INTERN_NAMES

F_INTERN_NS_URIS	back to summary
protected static final int F_INTERN_NS_URIS

F_LAZY_PARSING	back to summary
protected static final int F_LAZY_PARSING

F_NS_AWARE	back to summary
protected static final int F_NS_AWARE

F_PRESERVE_LOCATION	back to summary
protected static final int F_PRESERVE_LOCATION

F_REPORT_CDATA	back to summary
protected static final int F_REPORT_CDATA

F_RETAIN_ATTRIBUTE_GENERAL_ENTITIES	back to summary
protected static final int F_RETAIN_ATTRIBUTE_GENERAL_ENTITIES

illegalCharHandler	back to summary
private IllegalCharHandler illegalCharHandler

mActualEncoding	back to summary
private String mActualEncoding Name of the actual encoding that input was found to be in (if any -- can't be determined if a Reader was passed in).

mCanonicalizer	back to summary
private final UriCanonicalizer mCanonicalizer For efficient access by qualified name, as well as uniqueness checks, namespace URIs need to be canonicalized.

mEncCtxt	back to summary
private final ReaderConfig.EncodingContext mEncCtxt A single encoding context instance is shared between all ReaderConfig instances created for readers by an input factory. It is used for sharing symbol tables.

mExtEncoding	back to summary
private final String mExtEncoding Encoding passed in as external information, possibly from source from which xml content was gained from (for example, as an HTTP header, or file metadata).

mPublicId	back to summary
private final String mPublicId

mReporter	back to summary
private XMLReporter mReporter

mResolver	back to summary
private XMLResolver mResolver

mSystemId	back to summary
private final String mSystemId

mXmlDeclEncoding	back to summary
private String mXmlDeclEncoding

mXmlDeclStandalone	back to summary
private int mXmlDeclStandalone

mXmlDeclVersion	back to summary
private String mXmlDeclVersion

sProperties	back to summary
private static final HashMap<String, Object> sProperties

STANDALONE_NO	back to summary
public static final int STANDALONE_NO

STANDALONE_UNKNOWN	back to summary
public static final int STANDALONE_UNKNOWN

STANDALONE_YES	back to summary
public static final int STANDALONE_YES

Constructor Detail

ReaderConfig	back to summary
private ReaderConfig(String publicId, String systemId, String extEnc, ReaderConfig.EncodingContext encCtxt, int flags, int flagMods, XMLReporter rep, XMLResolver res, UriCanonicalizer canonicalizer)

ReaderConfig	back to summary
public ReaderConfig()

Method Detail

allocFullBBuffer	back to summary
public byte[] allocFullBBuffer(int minSize)

allocFullCBuffer	back to summary
public char[] allocFullCBuffer(int minSize)

allocMediumCBuffer	back to summary
public char[] allocMediumCBuffer(int minSize)

allocSmallCBuffer	back to summary
public char[] allocSmallCBuffer(int minSize)

canonicalizeURI	back to summary
public String canonicalizeURI(char[] buf, int uriLen)

configureForConvenience	back to summary
public void configureForConvenience() Method to call to make Reader created be as "convenient" to use as possible; ie try to avoid having to deal with some of things like segmented text chunks. This may incur some slight performance penalties, but should not affect XML conformance. See `XMLInputFactory2#configureForConvenience` for required settings for standard StAX/StAX2 properties.

configureForLowMemUsage back to summary

configureForLowMemUsage	back to summary
public void configureForLowMemUsage() Method to call to minimize the memory usage of the stream/event reader; both regarding Objects created, and the temporary memory usage during parsing. This generally incurs some performance penalties, due to using smaller input buffers. See `XMLInputFactory2#configureForLowMemUsage` for required settings for standard StAX/StAX2 properties.

public void configureForLowMemUsage()

Method to call to minimize the memory usage of the stream/event reader; both regarding Objects created, and the temporary memory usage during parsing. This generally incurs some performance penalties, due to using smaller input buffers.

See XMLInputFactory2#configureForLowMemUsage for required settings for standard StAX/StAX2 properties.

configureForRoundTripping back to summary

configureForRoundTripping	back to summary
public void configureForRoundTripping() Method to call to make Reader try to preserve as much of input formatting as possible, so that round-tripping would be as lossless as possible. See `XMLInputFactory2#configureForLowMemUsage` for required settings for standard StAX/StAX2 properties.

public void configureForRoundTripping()

Method to call to make Reader try to preserve as much of input formatting as possible, so that round-tripping would be as lossless as possible.

See XMLInputFactory2#configureForLowMemUsage for required settings for standard StAX/StAX2 properties.

configureForSpeed back to summary

configureForSpeed	back to summary
public void configureForSpeed() Method to call to make the Reader created be as fast as possible reading documents, especially for long-running processes where caching is likely to help. See `XMLInputFactory2#configureForSpeed` for required settings for standard StAX/StAX2 properties.

public void configureForSpeed()

Method to call to make the Reader created be as fast as possible reading documents, especially for long-running processes where caching is likely to help.

See XMLInputFactory2#configureForSpeed for required settings for standard StAX/StAX2 properties.

configureForXmlConformance back to summary

configureForXmlConformance	back to summary
public void configureForXmlConformance() Method to call to make Reader created conform as closely to XML standard as possible, doing all checks and transformations mandated (linefeed conversions, attr value normalizations). See `XMLInputFactory2#configureForXmlConformance` for required settings for standard StAX/StAX2 properties. Notes Does NOT change 'performance' settings (buffer sizes, DTD caching, coalescing, interning, accurate location info).

public void configureForXmlConformance()

Method to call to make Reader created conform as closely to XML standard as possible, doing all checks and transformations mandated (linefeed conversions, attr value normalizations). See XMLInputFactory2#configureForXmlConformance for required settings for standard StAX/StAX2 properties.

Notes

Does NOT change 'performance' settings (buffer sizes, DTD caching, coalescing, interning, accurate location info).

createNonShared	back to summary
public ReaderConfig createNonShared(String publicId, String systemId, String extEnc)

createRecycler	back to summary
private BufferRecycler createRecycler()

doAutoCloseInput	back to summary
public void doAutoCloseInput(boolean state)

doCoalesceText	back to summary
public void doCoalesceText(boolean state)

doParseLazily	back to summary
public void doParseLazily(boolean state)

doPreserveLocation	back to summary
public void doPreserveLocation(boolean state)

doReportCData	back to summary
public void doReportCData(boolean state)

doRetainAttributeGeneralEntities back to summary

public void doRetainAttributeGeneralEntities(boolean state)

Method for enabling or disabling AaltoInputProperties#P_RETAIN_ATTRIBUTE_GENERAL_ENTITIES.

Parameters

state:boolean: Whether to enable or disable property

Since

1.3

findPropertyId	back to summary
protected int findPropertyId(String propName)

freeFullBBuffer	back to summary
public void freeFullBBuffer(byte[] buffer)

freeFullCBuffer	back to summary
public void freeFullCBuffer(char[] buffer)

freeMediumCBuffer	back to summary
public void freeMediumCBuffer(char[] buffer)

freeSmallCBuffer	back to summary
public void freeSmallCBuffer(char[] buffer)

getActualEncoding

back to summary

public String getActualEncoding()

Implements abstract com.fasterxml.aalto.impl.CommonConfig.getActualEncoding.

Returns:String

Doc from com.fasterxml.aalto.impl.CommonConfig.getActualEncoding.

Actual encoding in use, as determined by the processor.

Annotations

@Override

getBBSymbols	back to summary
public ByteBasedPNameTable getBBSymbols()

getCBSymbols	back to summary
public CharBasedPNameTable getCBSymbols()

getCharTypes	back to summary
public XmlCharTypes getCharTypes()

getExternalEncoding

back to summary

public String getExternalEncoding()

Implements abstract com.fasterxml.aalto.impl.CommonConfig.getExternalEncoding.

Doc from com.fasterxml.aalto.impl.CommonConfig.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

Annotations

@Override

getIllegalCharHandler	back to summary
public IllegalCharHandler getIllegalCharHandler()

getProperty back to summary

public final Object getProperty(String name, boolean isMandatory)

Overrides com.fasterxml.aalto.impl.CommonConfig.getProperty.

Parameters

isMandatory:boolean

Doc from com.fasterxml.aalto.impl.CommonConfig.getProperty.

If true, unrecognized property should result in IllegalArgumentException

Annotations

@Override

getPublicId	back to summary
public String getPublicId()

getSystemId	back to summary
public String getSystemId()

getXmlDeclEncoding	back to summary
public String getXmlDeclEncoding()

getXmlDeclStandalone	back to summary
public int getXmlDeclStandalone()

getXmlDeclVersion	back to summary
public String getXmlDeclVersion()

getXMLReporter	back to summary
public XMLReporter getXMLReporter()

getXMLResolver	back to summary
public XMLResolver getXMLResolver()

hasInternNamesBeenEnabled	back to summary
public boolean hasInternNamesBeenEnabled()

hasInternNsURIsBeenEnabled	back to summary
public boolean hasInternNsURIsBeenEnabled()

isPropertySupported

back to summary

public boolean isPropertySupported(String propName)

Overrides com.fasterxml.aalto.impl.CommonConfig.isPropertySupported.

Annotations

@Override

isXml11

back to summary

public boolean isXml11()

Implements abstract com.fasterxml.aalto.impl.CommonConfig.isXml11.

Returns:boolean

Doc from com.fasterxml.aalto.impl.CommonConfig.isXml11.

True, if the processing will be done according to Xml 1.1 rules; false if according to xml 1.0

Annotations

@Override

setActualEncoding	back to summary
public void setActualEncoding(String actualEnc)

setIllegalCharHandler	back to summary
public void setIllegalCharHandler(IllegalCharHandler illegalCharHandler)

setProperty

back to summary

public boolean setProperty(String name, Object value)

Overrides com.fasterxml.aalto.impl.CommonConfig.setProperty.

Returns:boolean

Doc from com.fasterxml.aalto.impl.CommonConfig.setProperty.

True, if the specified property was succesfully set to specified value; false if its value was not changed

Annotations

@Override

setXmlDeclInfo	back to summary
public void setXmlDeclInfo(int version, String xmlDeclEnc, String standalone)

setXmlEncoding	back to summary
public final void setXmlEncoding(String enc)

setXMLReporter	back to summary
public void setXMLReporter(XMLReporter r)

setXMLResolver	back to summary
public void setXMLResolver(XMLResolver r)

setXmlStandalone	back to summary
public final void setXmlStandalone(Boolean b)

setXmlVersion	back to summary
public final void setXmlVersion(String version)

updateBBSymbols	back to summary
public void updateBBSymbols(ByteBasedPNameTable sym)

updateCBSymbols	back to summary
public void updateCBSymbols(CharBasedPNameTable sym)

willAutoCloseInput	back to summary
public boolean willAutoCloseInput()

willCoalesceText	back to summary
public boolean willCoalesceText()

willExpandEntities	back to summary
public boolean willExpandEntities()

willInternNames	back to summary
public boolean willInternNames()

willInternNsURIs	back to summary
public boolean willInternNsURIs()

willParseLazily	back to summary
public boolean willParseLazily()

willPreserveLocation	back to summary
public boolean willPreserveLocation()

willReportCData	back to summary
public boolean willReportCData()

willRetainAttributeGeneralEntities back to summary

public boolean willRetainAttributeGeneralEntities()

Accessor for checking configured state of AaltoInputProperties#P_RETAIN_ATTRIBUTE_GENERAL_ENTITIES.

Returns:boolean: Whether the property is enabled or disabled
Since: 1.3

willSupportNamespaces	back to summary
public boolean willSupportNamespaces()

com.fasterxml.aalto.in back to summary

pack-priv final Class ReaderConfig.EncodingContext

Class Inheritance

extends Object

java.lang.Object
com.fasterxml.aalto.in.ReaderConfig.EncodingContext

This is a simple container class that is used to encapsulate per-factory encoding-dependant information like symbol tables.

Field Summary

Modifier and Type	Field and Description
pack-priv ByteBasedPNameTable	mAsciiTable
pack-priv CharBasedPNameTable	mGeneralTable If there is no encoding to worry about, we only need a single symbol table.
pack-priv ByteBasedPNameTable	mLatin1Table
pack-priv ByteBasedPNameTable	mUtf8Table

Constructor Summary

Access	Constructor and Description
pack-priv	EncodingContext()

Method Summary

Modifier and Type	Method and Description
public synchronized ByteBasedPNameTable	getAsciiSymbols()
public synchronized ByteBasedPNameTable	getLatin1Symbols()
public synchronized CharBasedPNameTable	getSymbols()
public synchronized ByteBasedPNameTable	getUtf8Symbols()
public synchronized void	updateAsciiSymbols(ByteBasedPNameTable sym)
public synchronized void	updateLatin1Symbols(ByteBasedPNameTable sym)
public synchronized void	updateSymbols(CharBasedPNameTable sym)
public synchronized void	updateUtf8Symbols(ByteBasedPNameTable sym)

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

Field Detail

mAsciiTable	back to summary
pack-priv ByteBasedPNameTable mAsciiTable

mGeneralTable	back to summary
pack-priv CharBasedPNameTable mGeneralTable If there is no encoding to worry about, we only need a single symbol table.

mLatin1Table	back to summary
pack-priv ByteBasedPNameTable mLatin1Table

mUtf8Table	back to summary
pack-priv ByteBasedPNameTable mUtf8Table

Constructor Detail

EncodingContext	back to summary
pack-priv EncodingContext()

Method Detail

getAsciiSymbols	back to summary
public synchronized ByteBasedPNameTable getAsciiSymbols()

getLatin1Symbols	back to summary
public synchronized ByteBasedPNameTable getLatin1Symbols()

getSymbols	back to summary
public synchronized CharBasedPNameTable getSymbols()

getUtf8Symbols	back to summary
public synchronized ByteBasedPNameTable getUtf8Symbols()

updateAsciiSymbols	back to summary
public synchronized void updateAsciiSymbols(ByteBasedPNameTable sym)

updateLatin1Symbols	back to summary
public synchronized void updateLatin1Symbols(ByteBasedPNameTable sym)

updateSymbols	back to summary
public synchronized void updateSymbols(CharBasedPNameTable sym)

updateUtf8Symbols	back to summary
public synchronized void updateUtf8Symbols(ByteBasedPNameTable sym)

public final Class ReaderConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ReaderConfig.EncodingContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail