uk.ac.ed.ph.snuggletex

Enum SerializationMethod

java.lang.Object

java.lang.Enum<SerializationMethod>

uk.ac.ed.ph.snuggletex.SerializationMethod

All Implemented Interfaces:

Serializable, Comparable<SerializationMethod>

public enum SerializationMethod
extends Enum<SerializationMethod>

Enumerates the XML serialization methods available.

This is based on XSLT 2, but provides two HTML serialization methods - one which keeps non-XHTML in a namespace and one which moves everything into the null namespace.

NOTE: XHTML is only supported if you are using an XSLT 2.0 processor. If not supported, you will get XML output.

Version:

$Revision$

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML Default ("Partial") HTML serialization method.
STRICTLY_HTML Pure HTML serialization method.
XHTML XHTML Serialization method (if available)
XML XML Serialization method

Method Summary

Modifier and Type	Method and Description
String	getName()
static SerializationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static SerializationMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final SerializationMethod XML

XML Serialization method

XHTML

public static final SerializationMethod XHTML

XHTML Serialization method (if available)

HTML

public static final SerializationMethod HTML

Default ("Partial") HTML serialization method.

HTML elements are serialized in NO namespace, XML elements in the MathML and other namespaces are kept as-is

(This is how you might serialize HTML for IE/MathPlayer, for example)

NOTE: The old version of Xalan that comes bundled with Java 6 (and below) appears to be unable to indent HTML output when using XMLStringOutputOptions.setIndenting(boolean). I have not checked this behaviour with Java 7 (or above). I however recommend using Saxon, or including a newer version of Xalan in the ClassPath.

STRICTLY_HTML

public static final SerializationMethod STRICTLY_HTML

Pure HTML serialization method.

All XML elements have their namespaces removed on serialization. (Hence, there is the potential for name clashes if you use something like XLink & XHTML together.)

(This is how you would serialize HTML5, for example.)

Since:

1.3.0

Method Detail

values

public static SerializationMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SerializationMethod c : SerializationMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SerializationMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()