SerializationSpecifier (snuggletex-core 1.5.5 API)

所有已知实现类:

SerializationOptions, WebPageOutputOptions, XMLStringOutputOptions
```
public interface SerializationSpecifier
```
Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.
The main implementation of this is XMLStringOutputOptions, which you can use for normal SnuggleTeX functionality. There is also a SerializationOptions implementation that can be used for various utility classes, such as MathMLUtilities.

从以下版本开始:

1.2.0

另请参阅:

XMLStringOutputOptions, SerializationOptions

字段概要

字段
限定符和类型字段和说明

static java.lang.String DEFAULT_ENCODING
Default encoding to use

static int DEFAULT_INDENT
Default indent to use when isIndenting() returns true

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFAULT_ENCODING` Default encoding to use
`static int`	`DEFAULT_INDENT` Default indent to use when `isIndenting()` returns true

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`java.lang.String`	`getDoctypePublic()` Gets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_PUBLIC`.
`java.lang.String`	`getDoctypeSystem()` Gets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_SYSTEM`.
`java.lang.String`	`getEncoding()` Gets the encoding for the resulting serialized XML.
`int`	`getIndent()` Returns the indentation level to use when `isIndenting()` returns true.
`SerializationMethod`	`getSerializationMethod()` Gets the `SerializationMethod` to use when generating the final output.
`boolean`	`isIncludingXMLDeclaration()` Gets whether to include an XML declaration on the resulting output.
`boolean`	`isIndenting()` Returns whether the resulting XML will be indented or not.
`boolean`	`isUsingNamedEntities()` Returns whether to use named entities for certain MathML symbols rather than numeric character references.
`void`	`setDoctypePublic(java.lang.String doctypePublic)` Sets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_PUBLIC`.
`void`	`setDoctypeSystem(java.lang.String doctypeSystem)` Sets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_SYSTEM`.
`void`	`setEncoding(java.lang.String encoding)` Sets the encoding for the resulting serialized XML.
`void`	`setIncludingXMLDeclaration(boolean includingXMLDeclaration)` Sets whether to include an XML declaration on the resulting output.
`void`	`setIndent(int indent)` Sets the indentation level to use when `isIndenting()` returns true.
`void`	`setIndenting(boolean indenting)` Sets whether the resulting XML will be indented or not.
`void`	`setSerializationMethod(SerializationMethod serializationMethod)` Sets the `SerializationMethod` to use when generating the final output.
`void`	`setUsingNamedEntities(boolean usingNamedEntities)` Sets whether to use named entities for certain MathML symbols rather than numeric character references.

- 字段详细资料
  - DEFAULT_ENCODING
```
static final java.lang.String DEFAULT_ENCODING
```
    Default encoding to use
    
    另请参阅:
    
    常量字段值
  - DEFAULT_INDENT
```
static final int DEFAULT_INDENT
```
    Default indent to use when isIndenting() returns true
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getSerializationMethod
```
SerializationMethod getSerializationMethod()
```
    Gets the SerializationMethod to use when generating the final output.
    Default is SerializationMethod.XML. This must not be null.
    Note that SerializationMethod.XHTML is only supported properly if you are using an XSLT 2.0 processor; otherwise it reverts to SerializationMethod.XML
  - setSerializationMethod
```
void setSerializationMethod(SerializationMethod serializationMethod)
```
    Sets the SerializationMethod to use when generating the final output. This must not be null.
    Note that SerializationMethod.XHTML is only supported properly if you are using an XSLT 2.0 processor; otherwise it reverts to SerializationMethod.XML
    
    参数:
    
    serializationMethod - SerializationMethod to use, which must not be null.
  - getEncoding
```
java.lang.String getEncoding()
```
    Gets the encoding for the resulting serialized XML.
    Default is DEFAULT_ENCODING.
  - setEncoding
```
void setEncoding(java.lang.String encoding)
```
    Sets the encoding for the resulting serialized XML.
    Must not be null.
    
    参数:
    
    encoding - encoding to use, which must be non-null and recognised by the XSLT TransformerFactory that will end up doing the serialization.
  - isIndenting
```
boolean isIndenting()
```
    Returns whether the resulting XML will be indented or not. (This depends on how clever the underlying XSLT engine will be!)
    Default is false.
  - setIndenting
```
void setIndenting(boolean indenting)
```
    Sets whether the resulting XML will be indented or not. (This depends on how clever the underlying XSLT engine will be!)
    
    参数:
    
    indenting - true to indent, false otherwise.
  - getIndent
```
int getIndent()
```
    Returns the indentation level to use when isIndenting() returns true. (This is currently only supported if your underlying XSLT process is either Saxon or Xalan. This will be the case by if you have chosen to either use Saxon or use the default processor that ships with your Java platform.)
    This must be a non-negative integer.
    
    从以下版本开始:
    
    1.2.3
  - setIndent
```
void setIndent(int indent)
```
    Sets the indentation level to use when isIndenting() returns true. (This is currently only supported if your underlying XSLT process is either Saxon or Xalan. This will be the case by if you have chosen to either use Saxon or use the default processor that ships with your Java platform.)
    This must be a non-negative integer.
    
    从以下版本开始:
    
    1.2.3
  - isIncludingXMLDeclaration
```
boolean isIncludingXMLDeclaration()
```
    Gets whether to include an XML declaration on the resulting output. Default is false.
  - setIncludingXMLDeclaration
```
void setIncludingXMLDeclaration(boolean includingXMLDeclaration)
```
    Sets whether to include an XML declaration on the resulting output.
    
    参数:
    
    includingXMLDeclaration - true to include an XML declaration, false otherwise.
  - isUsingNamedEntities
```
boolean isUsingNamedEntities()
```
    Returns whether to use named entities for certain MathML symbols rather than numeric character references.
    Default is false.
  - setUsingNamedEntities
```
void setUsingNamedEntities(boolean usingNamedEntities)
```
    Sets whether to use named entities for certain MathML symbols rather than numeric character references.
    Note that this requires an XSLT 2.0-compliant engine (e.g. Saxon, which is in the "full" SnuggleTeX distribution.)
    (Also note that the resulting XML won't be parseable unless accompanied with a DTD defining the MathML entities!)
    
    参数:
    
    usingNamedEntities - true to use named entities, false to default to using numeric character references.
  - getDoctypePublic
```
java.lang.String getDoctypePublic()
```
    Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.
    Default is null
  - setDoctypePublic
```
void setDoctypePublic(java.lang.String doctypePublic)
```
    Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.
    
    参数:
    
    doctypePublic - public identifier to use, null for no identifier.
  - getDoctypeSystem
```
java.lang.String getDoctypeSystem()
```
    Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.
    Default is null
  - setDoctypeSystem
```
void setDoctypeSystem(java.lang.String doctypeSystem)
```
    Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.
    
    参数:
    
    doctypeSystem - system identifier to use, null for no identifier.

接口 SerializationSpecifier

字段概要

方法概要

字段详细资料

DEFAULT_ENCODING

DEFAULT_INDENT

方法详细资料

getSerializationMethod

setSerializationMethod

getEncoding

setEncoding

isIndenting

setIndenting

getIndent

setIndent

isIncludingXMLDeclaration

setIncludingXMLDeclaration

isUsingNamedEntities

setUsingNamedEntities

getDoctypePublic

setDoctypePublic

getDoctypeSystem

setDoctypeSystem