Package com.deltaxml.docbook.config

Class OutputParameters

java.lang.Object
com.deltaxml.docbook.config.OutputParameters
public class OutputParameters extends Object
These parameters enable the form of the output to be configured.

  • Constructor Details

    • OutputParameters

      public OutputParameters()
      Create a new OutputParameters instance. These parameters enable the form of the output to be configured.

    • OutputParameters

      public OutputParameters(boolean indentOutput)
      Create a new OutputParameters instance, setting whether the result should be indented. These parameters enable the form of the output to be configured.
      Parameters:
      indentOutput - whether the result should be indented.

    • OutputParameters

      public OutputParameters(OutputFormat outputFormat)
      Create a new OutputParameters instance, specifies what type of output is produced. These parameters enable the form of the output to be configured.
      Parameters:
      outputFormat - specifies what type of output is produced.

  • Method Details

    • isGrouping

      public boolean isGrouping()
      Gets the value of the grouping parameter.
      Returns:
      the value of the grouping parameter

    • setGrouping

      public void setGrouping(boolean value)

      Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block. One benefit of this is that changes to a consecutive group of words within a sentence are gathered into one insertion and one deletion block, rather than a series of individual word swaps. This makes it easier to read and understand the changes.

      Note that when either HTML or CALS table processing modes are selected, then this grouping mechanism is turned off within the context of these tables. The table processing has its own specialised grouping mechanisms.

      Default: false

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

    • isIndentOutput

      public boolean isIndentOutput()
      Gets the value of the indentOutput parameter.
      Returns:
      the value of the indentOutput parameter

    • setIndentOutput

      public void setIndentOutput(boolean value)

      Sets whether the result should be indented.

      If run with a compare method that produces a serialized result, a value of true causes the output to be pretty printed.

      Default: false

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

    • getOutputFormat

      public OutputFormat getOutputFormat()
      Gets the value of the outputFormat parameter.
      Returns:
      the value of the outputFormat parameter

    • setOutputFormat

      public void setOutputFormat(OutputFormat value)

      Specifies what type of output is produced.

      Default: OutputFormat.DOCBOOK_MARKUP

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

    • getPreservationMode

      public PreservationMode getPreservationMode()
      Gets the value of the preservationMode parameter.
      Returns:
      the value of the preservationMode parameter

    • setPreservationMode

      public void setPreservationMode(PreservationMode value)

      Sets the mode to use for preserving original data.

      This mode can be used to preserve information for round trip processing.

      The 'automatic' setting will have an effective setting of 'roundTrip' when the output format is a tracked change format and 'docAndAttrib' otherwise.

      Default: PreservationMode.AUTOMATIC

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

    • getTrackedChanges

      public TrackedChanges getTrackedChanges()
      Gets the current TrackedChanges sub configuration.
      Returns:
      the current TrackedChanges sub configuration

    • setTrackedChanges

      public void setTrackedChanges(TrackedChanges value)
      Sets the value of the TrackedChanges sub configuration.
      Parameters:
      value - the new TrackedChanges sub configuration to use

    • getPhraseChanges

      public PhraseChanges getPhraseChanges()
      Gets the current PhraseChanges sub configuration.
      Returns:
      the current PhraseChanges sub configuration

    • setPhraseChanges

      public void setPhraseChanges(PhraseChanges value)
      Sets the value of the PhraseChanges sub configuration.
      Parameters:
      value - the new PhraseChanges sub configuration to use