Top Description Fields Constructors Methods
uk.ac.ed.ph.snuggletex.upconversion

public final Class UpConversionOptions

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Static Imports
uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions.OPTION_DEFINITIONS, .UpConversionOptionDefinitions.SYMBOL_ASSUMPTION_TYPES

Encapsulates the various options and assumptions that can be used when running the up-conversion process.

(These can be set explicitly via this Java API, or using custom LaTeX macros as well.)

Author
David McKain
Since
1.2.0
Version
$Revision$

Field Summary

Modifier and TypeField and Description
private final Map<String, String>
private final Map<ElementWrapper, String>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
assumeSymbol(Element element, String assumptionType)

public void
public Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.

public Set<ElementWrapper>
public String
getEffectiveOptionValue(final String name, final boolean applyDefault)

public Set<String>
public String
public String
public String
public boolean
public void
setSpecifiedOption(final String name, final String value)

public void
Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

specifiedOptionMapback to summary
private final Map<String, String> specifiedOptionMap
symbolAssumptionsback to summary
private final Map<ElementWrapper, String> symbolAssumptions

Constructor Detail

UpConversionOptionsback to summary
public UpConversionOptions()

Method Detail

assumeSymbolback to summary
public void assumeSymbol(Element element, String assumptionType)
clearSpecifiedOptionback to summary
public void clearSpecifiedOption(final String name)
cloneback to summary
public Object clone()

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
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

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
getAssumedSymbolsback to summary
public Set<ElementWrapper> getAssumedSymbols()
getEffectiveOptionValueback to summary
public String getEffectiveOptionValue(final String name, final boolean applyDefault)
getSpecifiedOptionNamesback to summary
public Set<String> getSpecifiedOptionNames()
getSpecifiedOptionValueback to summary
public String getSpecifiedOptionValue(final String name)
getSymbolAssumptionTypeback to summary
public String getSymbolAssumptionType(Element element)
getSymbolAssumptionTypeback to summary
public String getSymbolAssumptionType(ElementWrapper elementWrapper)
isOptionSpecifiedback to summary
public boolean isOptionSpecified(final String name)
setSpecifiedOptionback to summary
public void setSpecifiedOption(final String name, final String value)
unassumeSymbolback to summary
public void unassumeSymbol(Element element)