Interface OutputFormat

All Known Implementing Classes:
BaseXercesOutputFormat, WeblogicXercesOutputFormat, XercesJDK5OutputFormat, XercesOutputFormat
public interface OutputFormat
Output format contract for XML serialization.
Author:
Werner Guttmann

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    XML
    Default serialization method, being XML

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getFormat()
    Returns the (underlying) OutputFormat instance
    void
    setDoctype(String type1, String type2)
    Defines the doc types to use.
    void
    setEncoding(String encoding)
    Sets the encoding to use.
    void
    setIndenting(boolean indent)
    Specify whether indentation is required
    void
    setMethod(String method)
    Set serialization method.
    void
    setOmitDocumentType(boolean omitDocumentType)
    Indicates whether to omit DOCTYPE definition.
    void
    setOmitXMLDeclaration(boolean omitXMLDeclaration)
    Indicates whether to omit XML declaration.
    void
    setPreserveSpace(boolean preserveSpace)
    Indicate whether white space should be preserved.
    void
    setVersion(String version)
    Defines the XML document version to be output.

  • Field Details

  • Method Details

    • setMethod

      void setMethod(String method)
      Set serialization method.
      Parameters:
      method - Required serialization method.

    • setIndenting

      void setIndenting(boolean indent)
      Specify whether indentation is required
      Parameters:
      indent - true if XML output should be intended.

    • setPreserveSpace

      void setPreserveSpace(boolean preserveSpace)
      Indicate whether white space should be preserved.
      Parameters:
      preserveSpace - True if white space should be preserved

    • getFormat

      Object getFormat()
      Returns the (underlying) OutputFormat instance
      Returns:
      the (underlying) OutputFormat instance

    • setDoctype

      void setDoctype(String type1, String type2)
      Defines the doc types to use.
      Parameters:
      type1 - Public DOC type.
      type2 - System doc type.

    • setOmitXMLDeclaration

      void setOmitXMLDeclaration(boolean omitXMLDeclaration)
      Indicates whether to omit XML declaration.
      Parameters:
      omitXMLDeclaration - True if XMl declaration should be omitted.

    • setOmitDocumentType

      void setOmitDocumentType(boolean omitDocumentType)
      Indicates whether to omit DOCTYPE definition.
      Parameters:
      omitDocumentType - True if DOCTYPE definition should be omitted.

    • setEncoding

      void setEncoding(String encoding)
      Sets the encoding to use.
      Parameters:
      encoding - The encoding to use.

    • setVersion

      void setVersion(String version)
      Defines the XML document version to be output.
      Parameters:
      encoding - The XML document version to be used.
      Since:
      1.3.2