Package com.deltaxml.docbook.config

Class AdvancedBehaviour

java.lang.Object
com.deltaxml.docbook.config.AdvancedBehaviour
public class AdvancedBehaviour extends Object
Contains parameters used to override or force specific behaviours.

  • Constructor Details

    • AdvancedBehaviour

      public AdvancedBehaviour()
      Constructs a default AdvancedBehaviour object. Contains parameters used to override or force specific behaviours.

    • AdvancedBehaviour

      public AdvancedBehaviour(String outputEncodingDeclaration)
      Constructs an AdvancedBehaviour object using the provided outputEncodingDeclaration. Contains parameters used to override or force specific behaviours.
      Parameters:
      outputEncodingDeclaration - the character encoding output used in the XML declaration.

    • AdvancedBehaviour

      public AdvancedBehaviour(XmlVersionDeclaration xmlVersionDeclaration)
      Constructs a default AdvancedBehaviour object using the provided XmlVersionDeclaration. Contains parameters used to override or force specific behaviours.
      Parameters:
      xmlVersionDeclaration - the value of the xmlVersionDeclaration.

    • AdvancedBehaviour

      public AdvancedBehaviour(boolean enableXinclude)
      Constructs an AdvancedBehaviour object, setting whether XInclude is enabled.
      Parameters:
      enableXinclude - whether XInclude is enabled.

    • AdvancedBehaviour

      public AdvancedBehaviour(String outputEncodingDeclaration, XmlVersionDeclaration xmlVersionDeclaration, boolean enableXinclude)
      Constructs an AdvancedBehaviour object with all possible parameters given.
      Parameters:
      outputEncodingDeclaration - the character encoding output used in the XML declaration.
      xmlVersionDeclaration - the value of the xmlVersionDeclaration.
      enableXinclude - whether XInclude is enabled.

  • Method Details

    • getOutputEncodingDeclaration

      public String getOutputEncodingDeclaration()
      Gets the character encoding output used in the XML declaration.
      Returns:
      output character encoding

    • setOutputEncodingDeclaration

      public void setOutputEncodingDeclaration(String value)

      Sets the character encoding output to use in the XML declaration. For example, 'UTF-8', 'ISO-8859-1', 'windows-1252', and 'ascii'. Precisely which encodings are available is dependent on the specific Java or runtime environment that you use. Note that an invalid output encoding will cause an exception to be raised.

      The 'system' special value is introduced; selecting it has the affect of choosing the 'B' document's character encoding.

      Default: "system"

      Parameters:
      value - the value to set for the outputEncodingDeclaration parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getXmlVersionDeclaration

      public XmlVersionDeclaration getXmlVersionDeclaration()
      Gets the value of the xmlVersionDeclaration.
      Returns:
      value of xmlVersionDeclaration

    • setXmlVersionDeclaration

      public void setXmlVersionDeclaration(XmlVersionDeclaration value)

      Sets the version to use in the XML declaration.

      The 'system' special value is introduced; selecting it has the affect of choosing 'B' document's xml-version (as provided by the parser).

      Default: XmlVersionDeclaration.SYSTEM

      Parameters:
      value - the value to set for the xmlVersionDeclaration parameter
      Throws:
      IllegalArgumentException - if the value is null
      See Also:

    • isEnableXinclude

      public boolean isEnableXinclude()
      Gets whether XInclude is enabled.
      Returns:
      value of the enableXinclude

    • setEnableXinclude

      public void setEnableXinclude(boolean value)

      Sets whether the parser will process xincludes.

      If set to true the parser will process xincludes while parsing the inputs.

      Default: true

      Parameters:
      value - the value to set for the enableXinclude parameter