Package org.jsoup.nodes
Class Document.OutputSettings
- java.lang.Object
-
- org.jsoup.nodes.Document.OutputSettings
-
- All Implemented Interfaces:
java.lang.Cloneable
- Enclosing class:
- Document
public static class Document.OutputSettings extends java.lang.Object implements java.lang.Cloneable
A Document's output settings control the form of the text() and html() methods.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Document.OutputSettings.Syntax
The output serialization syntax.
-
Field Summary
Fields Modifier and Type Field Description private java.nio.charset.Charset
charset
(package private) Entities.CoreCharset
coreCharset
private java.lang.ThreadLocal<java.nio.charset.CharsetEncoder>
encoderThreadLocal
private Entities.EscapeMode
escapeMode
private int
indentAmount
private boolean
outline
private boolean
prettyPrint
private Document.OutputSettings.Syntax
syntax
-
Constructor Summary
Constructors Constructor Description OutputSettings()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.nio.charset.Charset
charset()
Get the document's current output charset, which is used to control which characters are escaped when generating HTML (via thehtml()
methods), and which are kept intact.Document.OutputSettings
charset(java.lang.String charset)
Update the document's output charset.Document.OutputSettings
charset(java.nio.charset.Charset charset)
Update the document's output charset.Document.OutputSettings
clone()
(package private) java.nio.charset.CharsetEncoder
encoder()
Entities.EscapeMode
escapeMode()
Get the document's current HTML escape mode:base
, which provides a limited set of named HTML entities and escapes other characters as numbered entities for maximum compatibility; orextended
, which uses the complete set of HTML named entities.Document.OutputSettings
escapeMode(Entities.EscapeMode escapeMode)
Set the document's escape mode, which determines how characters are escaped when the output character set does not support a given character:- using either a named or a numbered escape.int
indentAmount()
Get the current tag indent amount, used when pretty printing.Document.OutputSettings
indentAmount(int indentAmount)
Set the indent amount for pretty printingboolean
outline()
Get if outline mode is enabled.Document.OutputSettings
outline(boolean outlineMode)
Enable or disable HTML outline mode.(package private) java.nio.charset.CharsetEncoder
prepareEncoder()
boolean
prettyPrint()
Get if pretty printing is enabled.Document.OutputSettings
prettyPrint(boolean pretty)
Enable or disable pretty printing.Document.OutputSettings.Syntax
syntax()
Get the document's current output syntax.Document.OutputSettings
syntax(Document.OutputSettings.Syntax syntax)
Set the document's output syntax.
-
-
-
Field Detail
-
escapeMode
private Entities.EscapeMode escapeMode
-
charset
private java.nio.charset.Charset charset
-
encoderThreadLocal
private java.lang.ThreadLocal<java.nio.charset.CharsetEncoder> encoderThreadLocal
-
coreCharset
Entities.CoreCharset coreCharset
-
prettyPrint
private boolean prettyPrint
-
outline
private boolean outline
-
indentAmount
private int indentAmount
-
syntax
private Document.OutputSettings.Syntax syntax
-
-
Method Detail
-
escapeMode
public Entities.EscapeMode escapeMode()
Get the document's current HTML escape mode:base
, which provides a limited set of named HTML entities and escapes other characters as numbered entities for maximum compatibility; orextended
, which uses the complete set of HTML named entities.The default escape mode is
base
.- Returns:
- the document's current escape mode
-
escapeMode
public Document.OutputSettings escapeMode(Entities.EscapeMode escapeMode)
Set the document's escape mode, which determines how characters are escaped when the output character set does not support a given character:- using either a named or a numbered escape.- Parameters:
escapeMode
- the new escape mode to use- Returns:
- the document's output settings, for chaining
-
charset
public java.nio.charset.Charset charset()
Get the document's current output charset, which is used to control which characters are escaped when generating HTML (via thehtml()
methods), and which are kept intact.Where possible (when parsing from a URL or File), the document's output charset is automatically set to the input charset. Otherwise, it defaults to UTF-8.
- Returns:
- the document's current charset.
-
charset
public Document.OutputSettings charset(java.nio.charset.Charset charset)
Update the document's output charset.- Parameters:
charset
- the new charset to use.- Returns:
- the document's output settings, for chaining
-
charset
public Document.OutputSettings charset(java.lang.String charset)
Update the document's output charset.- Parameters:
charset
- the new charset (by name) to use.- Returns:
- the document's output settings, for chaining
-
prepareEncoder
java.nio.charset.CharsetEncoder prepareEncoder()
-
encoder
java.nio.charset.CharsetEncoder encoder()
-
syntax
public Document.OutputSettings.Syntax syntax()
Get the document's current output syntax.- Returns:
- current syntax
-
syntax
public Document.OutputSettings syntax(Document.OutputSettings.Syntax syntax)
Set the document's output syntax. Eitherhtml
, with empty tags and boolean attributes (etc), orxml
, with self-closing tags.- Parameters:
syntax
- serialization syntax- Returns:
- the document's output settings, for chaining
-
prettyPrint
public boolean prettyPrint()
Get if pretty printing is enabled. Default is true. If disabled, the HTML output methods will not re-format the output, and the output will generally look like the input.- Returns:
- if pretty printing is enabled.
-
prettyPrint
public Document.OutputSettings prettyPrint(boolean pretty)
Enable or disable pretty printing.- Parameters:
pretty
- new pretty print setting- Returns:
- this, for chaining
-
outline
public boolean outline()
Get if outline mode is enabled. Default is false. If enabled, the HTML output methods will consider all tags as block.- Returns:
- if outline mode is enabled.
-
outline
public Document.OutputSettings outline(boolean outlineMode)
Enable or disable HTML outline mode.- Parameters:
outlineMode
- new outline setting- Returns:
- this, for chaining
-
indentAmount
public int indentAmount()
Get the current tag indent amount, used when pretty printing.- Returns:
- the current indent amount
-
indentAmount
public Document.OutputSettings indentAmount(int indentAmount)
Set the indent amount for pretty printing- Parameters:
indentAmount
- number of spaces to use for indenting each level. Must be >= 0.- Returns:
- this, for chaining
-
clone
public Document.OutputSettings clone()
- Overrides:
clone
in classjava.lang.Object
-
-