public final Class SerializationOptions

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

x.clone().getClass() == x.getClass()

x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Annotations

@Override

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.getDoctypePublic.

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

Default is null

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.getDoctypeSystem.

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

Default is null

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.getEncoding.

Gets the encoding for the resulting serialized XML.

Default is SerializationSpecifier#DEFAULT_ENCODING.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.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. The default value is SerializationSpecifier#DEFAULT_INDENT.

Since

1.2.3

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.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

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.isIncludingXMLDeclaration.

Gets whether to include an XML declaration on the resulting output. Default is false.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.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.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.isUsingNamedEntities.

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

Default is false.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setDoctypePublic.

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.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setDoctypeSystem.

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.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setEncoding.

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.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setIncludingXMLDeclaration.

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

Parameters

includingXMLDeclaration:boolean

true to include an XML declaration, false otherwise.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setIndent.

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. The default value is SerializationSpecifier#DEFAULT_INDENT.

Since

1.2.3

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setIndenting.

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.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setSerializationMethod.

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.

Implements uk.ac.ed.ph.snuggletex.SerializationSpecifier.setUsingNamedEntities.

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). This option will be silently ignored if you are using an XSLT 1.0 engine, such as the one which typically comes bundled with your JDK.

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

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override