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 Details

    • DEFAULT_AUTOMATIC_NS_PREFIX

      protected static final String DEFAULT_AUTOMATIC_NS_PREFIX
      See Also:

    • F_NS_REPAIRING

      static final int F_NS_REPAIRING
      See Also:

    • F_AUTO_CLOSE_OUTPUT

      static final int F_AUTO_CLOSE_OUTPUT
      See Also:

    • F_NS_AWARE

      static final int F_NS_AWARE
      See Also:

    • F_AUTO_EMPTY_ELEMS

      static final int F_AUTO_EMPTY_ELEMS
      See Also:

    • PROP_AUTO_NS_PREFIX

      static final int PROP_AUTO_NS_PREFIX
      See Also:

    • DEFAULT_FLAGS

      static final int DEFAULT_FLAGS
      See Also:

    • sProperties

      private static final HashMap<String,Integer> sProperties

    • _propAutoNsPrefix

      private String _propAutoNsPrefix

    • _encodingContext

      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.

    • _encoding

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

    • mRecyclerRef

      static final ThreadLocal<SoftReference<BufferRecycler>> mRecyclerRef
      This ThreadLocal contains a
      invalid reference 
      SoftRerefence
      to a BufferRecycler used to provide a low-cost buffer recycling between Reader instances.

    • _currRecycler

      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.

  • Constructor Details

  • Method Details

    • setActualEncodingIfNotSet

      public void setActualEncodingIfNotSet(String enc)

    • doAutoCloseOutput

      public void doAutoCloseOutput(boolean state)

    • enableXml11

      public void enableXml11()

    • createNonShared

      public WriterConfig createNonShared()

    • isXml11

      public boolean isXml11()
      Specified by:
      isXml11 in class CommonConfig
      Returns:
      True, if the processing will be done according to Xml 1.1 rules; false if according to xml 1.0

    • getExternalEncoding

      public String getExternalEncoding()
      Description copied from class: CommonConfig
      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]
      Specified by:
      getExternalEncoding in class CommonConfig
      Returns:
      Encoding that has been passed externally by the application

    • getActualEncoding

      public String getActualEncoding()
      Specified by:
      getActualEncoding in class CommonConfig
      Returns:
      Actual encoding in use, as determined by the processor.

    • getPreferredEncoding

      public String getPreferredEncoding()

    • getProperty

      public Object getProperty(String name, boolean isMandatory)
      Overrides:
      getProperty in class CommonConfig
      Parameters:
      isMandatory - If true, unrecognized property should result in IllegalArgumentException

    • setProperty

      public boolean setProperty(String name, Object value)
      Overrides:
      setProperty in class CommonConfig
      Returns:
      True, if the specified property was succesfully set to specified value; false if its value was not changed

    • isPropertySupported

      public boolean isPropertySupported(String propName)
      Overrides:
      isPropertySupported in class CommonConfig

    • willRepairNamespaces

      public boolean willRepairNamespaces()

    • isNamespaceAware

      public boolean isNamespaceAware()

    • willAutoCloseOutput

      public boolean willAutoCloseOutput()

    • getAutomaticNsPrefix

      public 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)

    • createRecycler

      private BufferRecycler createRecycler()

    • getUtf8Symbols

      public WNameTable getUtf8Symbols(WNameFactory f)

    • getLatin1Symbols

      public WNameTable getLatin1Symbols(WNameFactory f)

    • getAsciiSymbols

      public WNameTable getAsciiSymbols(WNameFactory f)

    • getCharSymbols

      public WNameTable getCharSymbols(WNameFactory f)