Package com.fasterxml.aalto.out
Class WriterConfig
- java.lang.Object
-
- com.fasterxml.aalto.impl.CommonConfig
-
- com.fasterxml.aalto.out.WriterConfig
-
public final class WriterConfig extends CommonConfig
This is the shared configuration object passed by the factory to writer.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.StringDEFAULT_AUTOMATIC_NS_PREFIX-
Fields inherited from class com.fasterxml.aalto.impl.CommonConfig
_flagMods, _flags, IMPL_NAME, IMPL_VERSION
-
-
Constructor Summary
Constructors Constructor Description WriterConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]allocFullBBuffer(int minSize)char[]allocFullCBuffer(int minSize)char[]allocMediumCBuffer(int minSize)voidconfigureForRobustness()voidconfigureForSpeed()For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.voidconfigureForXmlConformance()WriterConfigcreateNonShared()voiddoAutoCloseOutput(boolean state)voidenableXml11()voidfreeFullBBuffer(byte[] buffer)voidfreeFullCBuffer(char[] buffer)voidfreeMediumCBuffer(char[] buffer)java.lang.StringgetActualEncoding()WNameTablegetAsciiSymbols(WNameFactory f)java.lang.StringgetAutomaticNsPrefix()WNameTablegetCharSymbols(WNameFactory f)java.lang.StringgetExternalEncoding()This method returns name of encoding that has been passed explicitly to the reader or writer, from outside.WNameTablegetLatin1Symbols(WNameFactory f)java.lang.StringgetPreferredEncoding()java.lang.ObjectgetProperty(java.lang.String name, boolean isMandatory)WNameTablegetUtf8Symbols(WNameFactory f)booleanisNamespaceAware()booleanisPropertySupported(java.lang.String propName)booleanisXml11()voidsetActualEncodingIfNotSet(java.lang.String enc)booleansetProperty(java.lang.String name, java.lang.Object value)booleanwillAutoCloseOutput()booleanwillCheckAttributes()booleanwillCheckContent()booleanwillCheckNames()booleanwillCheckStructure()booleanwillEscapeCR()booleanwillFixContent()booleanwillRepairNamespaces()-
Methods inherited from class com.fasterxml.aalto.impl.CommonConfig
hasExplicitFlag, hasFlag, hasFlagBeenModified, setFlag
-
-
-
-
Field Detail
-
DEFAULT_AUTOMATIC_NS_PREFIX
protected static final java.lang.String DEFAULT_AUTOMATIC_NS_PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
setActualEncodingIfNotSet
public void setActualEncodingIfNotSet(java.lang.String enc)
-
doAutoCloseOutput
public void doAutoCloseOutput(boolean state)
-
enableXml11
public void enableXml11()
-
createNonShared
public WriterConfig createNonShared()
-
isXml11
public boolean isXml11()
- Specified by:
isXml11in classCommonConfig- Returns:
- True, if the processing will be done according to Xml 1.1 rules; false if according to xml 1.0
-
getExternalEncoding
public java.lang.String getExternalEncoding()
Description copied from class:CommonConfigThis 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]- Specified by:
getExternalEncodingin classCommonConfig- Returns:
- Encoding that has been passed externally by the application
-
getActualEncoding
public java.lang.String getActualEncoding()
- Specified by:
getActualEncodingin classCommonConfig- Returns:
- Actual encoding in use, as determined by the processor.
-
getPreferredEncoding
public java.lang.String getPreferredEncoding()
-
getProperty
public java.lang.Object getProperty(java.lang.String name, boolean isMandatory)- Overrides:
getPropertyin classCommonConfigisMandatory- If true, unrecognized property should result inIllegalArgumentException
-
setProperty
public boolean setProperty(java.lang.String name, java.lang.Object value)- Overrides:
setPropertyin classCommonConfig- Returns:
- True, if the specified property was succesfully set to specified value; false if its value was not changed
-
isPropertySupported
public boolean isPropertySupported(java.lang.String propName)
- Overrides:
isPropertySupportedin classCommonConfig
-
willRepairNamespaces
public boolean willRepairNamespaces()
-
isNamespaceAware
public boolean isNamespaceAware()
-
willAutoCloseOutput
public boolean willAutoCloseOutput()
-
getAutomaticNsPrefix
public java.lang.String getAutomaticNsPrefix()
- Returns:
- Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "axns".
-
configureForXmlConformance
public void configureForXmlConformance()
-
configureForRobustness
public void configureForRobustness()
-
configureForSpeed
public void configureForSpeed()
For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.
-
willCheckStructure
public boolean willCheckStructure()
-
willCheckContent
public boolean willCheckContent()
-
willCheckNames
public boolean willCheckNames()
-
willCheckAttributes
public boolean willCheckAttributes()
-
willFixContent
public boolean willFixContent()
-
willEscapeCR
public boolean willEscapeCR()
-
allocMediumCBuffer
public char[] allocMediumCBuffer(int minSize)
-
freeMediumCBuffer
public void freeMediumCBuffer(char[] buffer)
-
allocFullCBuffer
public char[] allocFullCBuffer(int minSize)
-
freeFullCBuffer
public void freeFullCBuffer(char[] buffer)
-
allocFullBBuffer
public byte[] allocFullBBuffer(int minSize)
-
freeFullBBuffer
public void freeFullBBuffer(byte[] buffer)
-
getUtf8Symbols
public WNameTable getUtf8Symbols(WNameFactory f)
-
getLatin1Symbols
public WNameTable getLatin1Symbols(WNameFactory f)
-
getAsciiSymbols
public WNameTable getAsciiSymbols(WNameFactory f)
-
getCharSymbols
public WNameTable getCharSymbols(WNameFactory f)
-
-