Uses of Class org.jdom.output.Format (JDOM v1.1.1)
Date: 2018-05-07

## Uses of Class
org.jdom.output.Format

- Packages that use Format
  Package | Description
  --- | ---
  org.jdom.output | Classes to output JDOM documents to various destinations.

- - ### Uses of Format in org.jdom.output

    Fields in org.jdom.output declared as Format
    Modifier and Type | Field and Description
    --- | ---
    `protected Format` | XMLOutputter.`currentFormat`
    `protected static Format` | XMLOutputter.`preserveFormat`

    Methods in org.jdom.output that return Format
    Modifier and Type | Method and Description
    --- | ---
    `static Format` | Format.`getCompactFormat()` Returns a new Format object that performs whitespace normalization, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.
    `Format` | XMLOutputter.`getFormat()` Returns the current format in use by the outputter.
    `static Format` | Format.`getPrettyFormat()` Returns a new Format object that performs whitespace beautification with 2-space indents, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.
    `static Format` | Format.`getRawFormat()` Returns a new Format object that performs no whitespace changes, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.
    `Format` | Format.`setEncoding(java.lang.String encoding)` Sets the output encoding.
    `Format` | Format.`setEscapeStrategy(EscapeStrategy strategy)` Sets the `EscapeStrategy` to use for character escaping.
    `Format` | Format.`setExpandEmptyElements(boolean expandEmptyElements)` This will set whether empty elements are expanded from `<tagName/>` to `<tagName></tagName>`.
    `Format` | Format.`setIndent(java.lang.String indent)` This will set the indent `String` to use; this is usually a `String` of empty spaces.
    `Format` | Format.`setLineSeparator(java.lang.String separator)` This will set the newline separator (`lineSeparator`).
    `Format` | Format.`setOmitDeclaration(boolean omitDeclaration)` This will set whether the XML declaration (`<?xml version="1.0"?gt;`) will be omitted or not.
    `Format` | Format.`setOmitEncoding(boolean omitEncoding)` This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?>`) includes the encoding of the document.
    `Format` | Format.`setTextMode(Format.TextMode mode)` This sets the text output style.

    Methods in org.jdom.output with parameters of type Format
    Modifier and Type | Method and Description
    --- | ---
    `void` | XMLOutputter.`setFormat(Format newFormat)` Sets the new format logic for the outputter.

    Constructors in org.jdom.output with parameters of type Format
    Constructor and Description
    `XMLOutputter(Format format)` This will create an `XMLOutputter` with the specified format characteristics.

Copyright ? 2007 Jason Hunter, Brett McLaughlin. All Rights Reserved.