com.deltaxml.cores9api.config

Enum MathMLGranularity

java.lang.Object

java.lang.Enum<MathMLGranularity>

com.deltaxml.cores9api.config.MathMLGranularity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MathMLGranularity>

public enum MathMLGranularity
extends java.lang.Enum<MathMLGranularity>

Specifies the granularity at which the differences between the two MathML expressions will be represented from the DocumentComparator.

Since:

11.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJACENT Reports the differences to the MathML by repeating A and B MathML inputs adjacent to each other.
DETAILED_ADJACENT Reports the differences to the MathML by repeating the A and B MathML inputs adjacent to each other, with individual changes highlighted.
INLINE Reports the differences within the MathML without duplicating A and B.

Method Summary

Modifier and Type	Method and Description
static MathMLGranularity	getMathMLGranularity(java.lang.String val) Returns the MathMLGranularity instance representing the supplied String value.
java.lang.String	toString() The camel case string form of each of the enumerated type constants.
static MathMLGranularity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MathMLGranularity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADJACENT

public static final MathMLGranularity ADJACENT

Reports the differences to the MathML by repeating A and B MathML inputs adjacent to each other. Whole MathML sections will be highlighted by background colours (#ffcbcb for A and #bbffbb for B) by using a style attribute 'mathbackground'. The advantage of this result is that the MathML will always render correctly if the inputs rendered correctly. Please note that repeating the equation means that it will take up twice as much space so this isn't necessarily the best option if pagination or layout is an issue.

DETAILED_ADJACENT

public static final MathMLGranularity DETAILED_ADJACENT

Reports the differences to the MathML by repeating the A and B MathML inputs adjacent to each other, with individual changes highlighted. The individual changes will be highlighted by background colours (#ffcbcb for A and #bbffbb for B) by using a style attribute 'mathbackground'.

INLINE

public static final MathMLGranularity INLINE

Reports the differences within the MathML without duplicating A and B. However, due to the nature of some MathML elements and their required argument types, it may be necessary to present the changes at a 'higher' level than that which they occurred at. The inline changes will be highlighted by background colours (#ffcbcb for A and #bbffbb for B) by using a style attribute 'mathbackground'.

Method Detail

values

public static MathMLGranularity[] 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 (MathMLGranularity c : MathMLGranularity.values())
    System.out.println(c);

Returns:

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

valueOf

public static MathMLGranularity valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

The camel case string form of each of the enumerated type constants. Here, the string for an enumeration constant of the form 'FIRST_SECOND_THIRD' is 'firstSecondThird'.

Overrides:

toString in class java.lang.Enum<MathMLGranularity>

Returns:

The camel case string form of each of the enumerated type constants.

getMathMLGranularity

public static MathMLGranularity getMathMLGranularity(java.lang.String val)

Returns the MathMLGranularity instance representing the supplied String value.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

val - a Sting representation of a MathMLGranularity value or null for the default value

Returns:

the MathMLGranularity instance corresponding to the parameter, or null if the value is invalid