Package com.deltaxml.dita.config

Class AdvancedBehaviour

java.lang.Object
com.deltaxml.dita.config.AdvancedBehaviour
public class AdvancedBehaviour extends Object
Parameters used to override or force specific behaviours.

  • Constructor Details

    • AdvancedBehaviour

      public AdvancedBehaviour()
      Create a new AdvancedBehaviour instance. AdvancedBehaviour contains parameters used to override or force specific behaviours.

  • Method Details

    • getOutputEncodingDeclaration

      public String getOutputEncodingDeclaration()
      Gets the value of the outputEncodingDeclaration parameter.
      Returns:
      the value of the outputEncodingDeclaration parameter

    • 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 .NET 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

    • getTopicPublicId

      public String getTopicPublicId()
      Gets the value of the topicPublicId parameter.
      Returns:
      the value of the topicPublicId parameter

    • setTopicPublicId

      public void setTopicPublicId(String value)

      Specifies the publicId to use for a Topic doctype.

      A value should only be passed if you wish to override the default values for the publicId (-//OASIS//DTD DITA 1.1 Topic//EN for DITA 1.1 and -//OASIS//DTD DITA 1.2 Topic//EN for DITA 1.2)

      Note that this value is only used if the following are true:

      • The input documents are different DITA specializations, or only one of them is specialized
      • At least one of the input documents specified a doctype
      • The comparison has not been configured to re-specialize the result document even if the inputs were different types

      Default: ""

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

    • getTopicSystemId

      public String getTopicSystemId()
      Gets the value of the topicSystemId parameter.
      Returns:
      the value of the topicSystemId parameter

    • setTopicSystemId

      public void setTopicSystemId(String value)

      Specifies the systemId to use for a Topic doctype.

      A value should only be passed if you wish to override the default values for the publicId (http://docs.oasis-open.org/dita/v1.1/OS/dtd/topic.dtd for DITA 1.1 and http://docs.oasis-open.org/dita/v1.2/os/dtd1.2/technicalContent/dtd/topic.dtd for DITA 1.2)

      Note that this value is only used if the following are true:

      • The input documents are different DITA specializations, or only one of them is specialized
      • At least one of the input documents specified a doctype
      • The comparison has not been configured to re-specialize the result document even if the inputs were different types

      Default: ""

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

    • getXmlVersionDeclaration

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

    • 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:

    • isForceSpecialization

      public boolean isForceSpecialization()
      Gets the value of the forceSpecialization parameter.
      Returns:
      the value of the forceSpecialization parameter

    • setForceSpecialization

      public void setForceSpecialization(boolean value)

      Specifies whether or not to force result specialization when the input types are different.

      If this value is set to false and the input documents are different DITA types, the result document will be left in its generalized form with class attributes to indicate what the specializations are.

      If this value is set to true and the input documents are different DITA types, the result document will be specialized to the DITA type of the second input. Please note that this may produce a result document that is not valid against its doctype.

      Default: false

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