Modifier and Type	Class and Description
pack-priv static class	WriterConfig.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 BufferRecycler	_currRecycler This is the actually container of the recyclable buffers.
private String	_encoding Encoding passed in either during construction, or via xml declaration write.
private final WriterConfig.EncodingContext	_encodingContext A single encoding context instance is shared between all WriterConfig instances created for readers by an output factory.
private String	_propAutoNsPrefix
protected static final String	DEFAULT_AUTOMATIC_NS_PREFIX
pack-priv static final int	DEFAULT_FLAGS
pack-priv static final int	F_AUTO_CLOSE_OUTPUT
pack-priv static final int	F_AUTO_EMPTY_ELEMS
pack-priv static final int	F_NS_AWARE
pack-priv static final int	F_NS_REPAIRING
pack-priv static final ThreadLocal<SoftReference<BufferRecycler>>	mRecyclerRef This `ThreadLocal` contains a `SoftRerefence` to a `BufferRecycler` used to provide a low-cost buffer recycling between Reader instances.
pack-priv static final int	PROP_AUTO_NS_PREFIX
private static final HashMap<String, Integer>	sProperties

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

Constructor Summary

Access	Constructor and Description
private	WriterConfig(String encoding, int flags, int flagMods, WriterConfig.EncodingContext encCtxt, String autoNsPrefix)
public	WriterConfig()

Method Summary

Modifier and Type	Method and Description
public byte[]	allocFullBBuffer(int minSize)
public char[]	allocFullCBuffer(int minSize)
public char[]	allocMediumCBuffer(int minSize)
public void	configureForRobustness()
public void	configureForSpeed() For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.
public void	configureForXmlConformance()
public WriterConfig	createNonShared()
private BufferRecycler	createRecycler()
public void	doAutoCloseOutput(boolean state)
public void	enableXml11()
public void	freeFullBBuffer(byte[] buffer)
public void	freeFullCBuffer(char[] buffer)
public void	freeMediumCBuffer(char[] buffer)
public String	getActualEncoding() Implements abstract com.fasterxml.aalto.impl.CommonConfig.getActualEncoding.
public WNameTable	getAsciiSymbols(WNameFactory f)
public String	Returns: Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "axns". getAutomaticNsPrefix()
public WNameTable	getCharSymbols(WNameFactory f)
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 WNameTable	getLatin1Symbols(WNameFactory f)
public String	getPreferredEncoding()
public Object	getProperty(String name, boolean If true, unrecognized property should result in `IllegalArgumentException` isMandatory) Overrides com.fasterxml.aalto.impl.CommonConfig.getProperty.
public WNameTable	getUtf8Symbols(WNameFactory f)
public boolean	isNamespaceAware()
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	setActualEncodingIfNotSet(String enc)
public boolean	setProperty(String name, Object value) Overrides com.fasterxml.aalto.impl.CommonConfig.setProperty.
public boolean	willAutoCloseOutput()
public boolean	willCheckAttributes()
public boolean	willCheckContent()
public boolean	willCheckNames()
public boolean	willCheckStructure()
public boolean	willEscapeCR()
public boolean	willFixContent()
public boolean	willRepairNamespaces()

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

Field Detail

_currRecycler	back to summary
pack-priv 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.

_encoding	back to summary
private String _encoding Encoding passed in either during construction, or via xml declaration write.

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

_propAutoNsPrefix	back to summary
private String _propAutoNsPrefix

DEFAULT_AUTOMATIC_NS_PREFIX	back to summary
protected static final String DEFAULT_AUTOMATIC_NS_PREFIX

DEFAULT_FLAGS	back to summary
pack-priv static final int DEFAULT_FLAGS

F_AUTO_CLOSE_OUTPUT	back to summary
pack-priv static final int F_AUTO_CLOSE_OUTPUT

F_AUTO_EMPTY_ELEMS	back to summary
pack-priv static final int F_AUTO_EMPTY_ELEMS

F_NS_AWARE	back to summary
pack-priv static final int F_NS_AWARE

F_NS_REPAIRING	back to summary
pack-priv static final int F_NS_REPAIRING

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

PROP_AUTO_NS_PREFIX	back to summary
pack-priv static final int PROP_AUTO_NS_PREFIX

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

Constructor Detail

WriterConfig	back to summary
private WriterConfig(String encoding, int flags, int flagMods, WriterConfig.EncodingContext encCtxt, String autoNsPrefix)

WriterConfig	back to summary
public WriterConfig()

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)

configureForRobustness	back to summary
public void configureForRobustness()

configureForSpeed	back to summary
public void configureForSpeed() For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.

configureForXmlConformance	back to summary
public void configureForXmlConformance()

createNonShared	back to summary
public WriterConfig createNonShared()

createRecycler	back to summary
private BufferRecycler createRecycler()

doAutoCloseOutput	back to summary
public void doAutoCloseOutput(boolean state)

enableXml11	back to summary
public void enableXml11()

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)

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

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

getAsciiSymbols	back to summary
public WNameTable getAsciiSymbols(WNameFactory f)

getAutomaticNsPrefix	back to summary
public String getAutomaticNsPrefix() Returns:String Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "axns".

getCharSymbols	back to summary
public WNameTable getCharSymbols(WNameFactory f)

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

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

getLatin1Symbols	back to summary
public WNameTable getLatin1Symbols(WNameFactory f)

getPreferredEncoding	back to summary
public String getPreferredEncoding()

getProperty back to summary

getProperty	back to summary
public 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

public 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

getUtf8Symbols	back to summary
public WNameTable getUtf8Symbols(WNameFactory f)

isNamespaceAware	back to summary
public boolean isNamespaceAware()

isPropertySupported	back to summary
public boolean isPropertySupported(String propName) Overrides com.fasterxml.aalto.impl.CommonConfig.isPropertySupported. Annotations @Override

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

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

setActualEncodingIfNotSet	back to summary
public void setActualEncodingIfNotSet(String enc)

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

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

willAutoCloseOutput	back to summary
public boolean willAutoCloseOutput()

willCheckAttributes	back to summary
public boolean willCheckAttributes()

willCheckContent	back to summary
public boolean willCheckContent()

willCheckNames	back to summary
public boolean willCheckNames()

willCheckStructure	back to summary
public boolean willCheckStructure()

willEscapeCR	back to summary
public boolean willEscapeCR()

willFixContent	back to summary
public boolean willFixContent()

willRepairNamespaces	back to summary
public boolean willRepairNamespaces()

com.fasterxml.aalto.out back to summary

pack-priv final Class WriterConfig.EncodingContext

Class Inheritance

extends Object

java.lang.Object
com.fasterxml.aalto.out.WriterConfig.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 WNameTable	mAsciiTable
pack-priv WNameTable	mCharTable
pack-priv WNameTable	mLatin1Table
pack-priv WNameTable	mUtf8Table

Constructor Summary

Access	Constructor and Description
pack-priv	EncodingContext()

Method Summary

Modifier and Type	Method and Description
public synchronized WNameTable	getAsciiSymbols(WNameFactory f)
public synchronized WNameTable	getCharSymbols(WNameFactory f)
public synchronized WNameTable	getLatin1Symbols(WNameFactory f)
public synchronized WNameTable	getUtf8Symbols(WNameFactory f)

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

Field Detail

mAsciiTable	back to summary
pack-priv WNameTable mAsciiTable

mCharTable	back to summary
pack-priv WNameTable mCharTable

mLatin1Table	back to summary
pack-priv WNameTable mLatin1Table

mUtf8Table	back to summary
pack-priv WNameTable mUtf8Table

Constructor Detail

EncodingContext	back to summary
pack-priv EncodingContext()

Method Detail

getAsciiSymbols	back to summary
public synchronized WNameTable getAsciiSymbols(WNameFactory f)

getCharSymbols	back to summary
public synchronized WNameTable getCharSymbols(WNameFactory f)

getLatin1Symbols	back to summary
public synchronized WNameTable getLatin1Symbols(WNameFactory f)

getUtf8Symbols	back to summary
public synchronized WNameTable getUtf8Symbols(WNameFactory f)

public final Class WriterConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class WriterConfig.EncodingContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail