Top Description Inners Fields Constructors Methods
uk.ac.ed.ph.snuggletex.semantics

public final Class MathBracketInterpretation

extends Object
implements MathInterpretation
Class Inheritance
All Implemented Interfaces
uk.ac.ed.ph.snuggletex.semantics.MathInterpretation, uk.ac.ed.ph.snuggletex.semantics.Interpretation
Imports
uk.ac.ed.ph.snuggletex.definitions.MathCharacter, uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities
Supplementary interpretation indicating that a certain operator is a MathML bracket.
Author
David McKain
Version
$Revision$

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
MathBracketInterpretation.BracketType

Field Summary

Modifier and TypeField and Description
private final MathBracketInterpretation.BracketType
bracketType

private final MathCharacter
mfencedAttributeCharacter

MathCharacter for resulting mfenced open/close attribute.

private final boolean
pairingInferencePossible

Flag denoting whether to allow pairs of brackets of this type to be inferred during Token Fixing.

Constructor Summary

AccessConstructor and Description
public
MathBracketInterpretation(final MathCharacter mfencedAttributeCharacter, final MathBracketInterpretation.BracketType bracketType, final boolean pairingInferencePossible)

Method Summary

Modifier and TypeMethod and Description
public MathBracketInterpretation.BracketType
getBracketType()

public MathCharacter
getMfencedAttributeCharacter()

public InterpretationType
getType()

Implements uk.ac.ed.ph.snuggletex.semantics.Interpretation.getType.

public boolean
isPairingInferencePossible()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

bracketTypeback to summary
private final MathBracketInterpretation.BracketType bracketType
mfencedAttributeCharacterback to summary
private final MathCharacter mfencedAttributeCharacter

MathCharacter for resulting mfenced open/close attribute. This allows brackets to map to different open/close characters if they also have meaning as standalone operators, such as the '<' operator.

pairingInferencePossibleback to summary
private final boolean pairingInferencePossible

Flag denoting whether to allow pairs of brackets of this type to be inferred during Token Fixing. This is not always safe for things like angle brackets, which also mean less than or greater than.

Constructor Detail

MathBracketInterpretationback to summary
public MathBracketInterpretation(final MathCharacter mfencedAttributeCharacter, final MathBracketInterpretation.BracketType bracketType, final boolean pairingInferencePossible)

Method Detail

getBracketTypeback to summary
public MathBracketInterpretation.BracketType getBracketType()
getMfencedAttributeCharacterback to summary
public MathCharacter getMfencedAttributeCharacter()
getTypeback to summary
public InterpretationType getType()

Implements uk.ac.ed.ph.snuggletex.semantics.Interpretation.getType.

isPairingInferencePossibleback to summary
public boolean isPairingInferencePossible()
toStringback to summary
public String toString()

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
uk.ac.ed.ph.snuggletex.semantics back to summary

public final Enum MathBracketInterpretation.BracketType

extends Enum<MathBracketInterpretation.BracketType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final MathBracketInterpretation.BracketType
CLOSER

public static final MathBracketInterpretation.BracketType
OPENER

public static final MathBracketInterpretation.BracketType
OPENER_OR_CLOSER

Constructor Summary

AccessConstructor and Description
private
BracketType()

Method Summary

Modifier and TypeMethod and Description
public static MathBracketInterpretation.BracketType
valueOf(String name)

public static MathBracketInterpretation.BracketType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLOSERback to summary
public static final MathBracketInterpretation.BracketType CLOSER
OPENERback to summary
public static final MathBracketInterpretation.BracketType OPENER
OPENER_OR_CLOSERback to summary
public static final MathBracketInterpretation.BracketType OPENER_OR_CLOSER

Constructor Detail

BracketTypeback to summary
private BracketType()

Method Detail

valueOfback to summary
public static MathBracketInterpretation.BracketType valueOf(String name)
valuesback to summary
public static MathBracketInterpretation.BracketType[] values()