SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.SerializationSpecifier

Modifier and Type	Field and Description
public static final String	DEFAULT_ENCODING Default encoding to use
public static final int	DEFAULT_INDENT Default indent to use when `isIndenting()` returns true

Method Summary

Modifier and Type	Method and Description
public String	getDoctypePublic() Gets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_PUBLIC`.
public String	getDoctypeSystem() Gets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_SYSTEM`.
public String	getEncoding() Gets the encoding for the resulting serialized XML.
public int	getIndent() Returns the indentation level to use when `isIndenting()` returns true.
public SerializationMethod	getSerializationMethod() Gets the `SerializationMethod` to use when generating the final output.
public boolean	isIncludingXMLDeclaration() Gets whether to include an XML declaration on the resulting output.
public boolean	isIndenting() Returns whether the resulting XML will be indented or not.
public boolean	isUsingNamedEntities() Returns whether to use named entities for certain MathML symbols rather than numeric character references.
public void	setDoctypePublic(String public identifier to use, null for no identifier. doctypePublic) Sets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_PUBLIC`.
public void	setDoctypeSystem(String system identifier to use, null for no identifier. doctypeSystem) Sets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_SYSTEM`.
public void	setEncoding(String encoding to use, which must be non-null and recognised by the XSLT `TransformerFactory` that will end up doing the serialization. encoding) Sets the encoding for the resulting serialized XML.
public void	setIncludingXMLDeclaration(boolean true to include an XML declaration, false otherwise. includingXMLDeclaration) Sets whether to include an XML declaration on the resulting output.
public void	setIndent(int indent) Sets the indentation level to use when `isIndenting()` returns true.
public void	setIndenting(boolean true to indent, false otherwise. indenting) Sets whether the resulting XML will be indented or not.
public void	setSerializationMethod(SerializationMethod `SerializationMethod` to use, which must not be null. serializationMethod) Sets the `SerializationMethod` to use when generating the final output.
public void	setUsingNamedEntities(boolean true to use named entities, false to default to using numeric character references. usingNamedEntities) Sets whether to use named entities for certain MathML symbols rather than numeric character references.

DEFAULT_ENCODING	back to summary
public static final String DEFAULT_ENCODING Default encoding to use

DEFAULT_INDENT	back to summary
public static final int DEFAULT_INDENT Default indent to use when `isIndenting()` returns true

Method Detail

getDoctypePublic back to summary

getDoctypePublic	back to summary
public String getDoctypePublic() Gets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_PUBLIC`. Default is null

public String getDoctypePublic()

Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys#DOCTYPE_PUBLIC.

Default is null

getDoctypeSystem back to summary

getDoctypeSystem	back to summary
public String getDoctypeSystem() Gets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_SYSTEM`. Default is null

public String getDoctypeSystem()

Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys#DOCTYPE_SYSTEM.

Default is null

getEncoding back to summary

getEncoding	back to summary
public String getEncoding() Gets the encoding for the resulting serialized XML. Default is `SerializationSpecifier#DEFAULT_ENCODING`.

public String getEncoding()

Gets the encoding for the resulting serialized XML.

Default is SerializationSpecifier#DEFAULT_ENCODING.

getIndent back to summary

getIndent	back to summary
public 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. Since 1.2.3

public 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.

Since: 1.2.3

getSerializationMethod back to summary

getSerializationMethod	back to summary
public 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`

public 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

isIncludingXMLDeclaration	back to summary
public boolean isIncludingXMLDeclaration() Gets whether to include an XML declaration on the resulting output. Default is false.

isIndenting	back to summary
public 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.

isIndenting

back to summary

public 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.

isUsingNamedEntities	back to summary
public boolean isUsingNamedEntities() Returns whether to use named entities for certain MathML symbols rather than numeric character references. Default is false.

isUsingNamedEntities

back to summary

public boolean isUsingNamedEntities()

Returns whether to use named entities for certain MathML symbols rather than numeric character references.

Default is false.

setDoctypePublic back to summary

setDoctypePublic	back to summary
public void setDoctypePublic(String doctypePublic) Sets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_PUBLIC`. Parameters doctypePublic:String public identifier to use, null for no identifier.

public void setDoctypePublic(String doctypePublic)

Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys#DOCTYPE_PUBLIC.

Parameters

doctypePublic:String: public identifier to use, null for no identifier.

setDoctypeSystem back to summary

setDoctypeSystem	back to summary
public void setDoctypeSystem(String doctypeSystem) Sets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys#DOCTYPE_SYSTEM`. Parameters doctypeSystem:String system identifier to use, null for no identifier.

public void setDoctypeSystem(String doctypeSystem)

Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys#DOCTYPE_SYSTEM.

Parameters

doctypeSystem:String: system identifier to use, null for no identifier.

setEncoding back to summary

setEncoding	back to summary
public void setEncoding(String encoding) Sets the encoding for the resulting serialized XML. Must not be null. Parameters encoding:String encoding to use, which must be non-null and recognised by the XSLT `TransformerFactory` that will end up doing the serialization.

public void setEncoding(String encoding)

Sets the encoding for the resulting serialized XML.

Must not be null.

Parameters

encoding:String: encoding to use, which must be non-null and recognised by the XSLT TransformerFactory that will end up doing the serialization.

setIncludingXMLDeclaration	back to summary
public void setIncludingXMLDeclaration(boolean includingXMLDeclaration) Sets whether to include an XML declaration on the resulting output. Parameters includingXMLDeclaration:boolean true to include an XML declaration, false otherwise.

setIncludingXMLDeclaration

back to summary

public void setIncludingXMLDeclaration(boolean includingXMLDeclaration)

Sets whether to include an XML declaration on the resulting output.

Parameters

includingXMLDeclaration:boolean: true to include an XML declaration, false otherwise.

setIndent back to summary

setIndent	back to summary
public 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. Since 1.2.3

public 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.

Since: 1.2.3

setIndenting	back to summary
public 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!) Parameters indenting:boolean true to indent, false otherwise.

setIndenting

back to summary

public 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!)

Parameters

indenting:boolean: true to indent, false otherwise.

setSerializationMethod back to summary

setSerializationMethod	back to summary
public 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` Parameters serializationMethod:SerializationMethod `SerializationMethod` to use, which must not be null.

public 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

Parameters

serializationMethod:SerializationMethod: SerializationMethod to use, which must not be null.

setUsingNamedEntities	back to summary
public 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!) Parameters usingNamedEntities:boolean true to use named entities, false to default to using numeric character references.

setUsingNamedEntities

back to summary

public 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!)

Parameters

usingNamedEntities:boolean: true to use named entities, false to default to using numeric character references.

public Interface SerializationSpecifier

Field Summary

Method Summary

Field Detail

Method Detail