SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.SnuggleSession

Modifier and Type	Class and Description
public static enum	SnuggleSession.EndOutputAction Trivial enumeration which specifies the possible actions to perform once we finish writing with the various `SnuggleSession#writeWebPage(WebPageOutputOptions, OutputStream)` methods.

Modifier and Type	Field and Description
private final SessionConfiguration	configuration Configuration for this session
pack-priv final DOMOutputOptions	defaultDOMOutputOptions Default `DOMOutputOptions`, copied from the owning `SnuggleEngine` during creation
pack-priv final XMLStringOutputOptions	defaultXMLStringOutputOptions Default `XMLStringOutputOptions`, copied from the owning `SnuggleEngine` during creation
private final SnuggleEngine	engine Engine that created this Session
private final List<InputError>	errors Errors accumulated during this session
private final SnugglePackage[]	packages Copy of the List of all currently registered `SnugglePackage`s used by the underlying Engine.
private final List<FlowToken>	parsedTokens All tokens currently completely parsed (and fixed) by this session
private final StyleEvaluator	styleEvaluator
private final StyleRebuilder	styleRebuilder
private final TokenFixer	tokenFixer `TokenFixer` used to massage inputs after parsing
private final LaTeXTokeniser	tokeniser `LaTeXTokeniser` used to parse inputs
private final Map<String, UserDefinedCommand>	userCommandMap Map of user-defined commands, keyed on name
private final Map<String, UserDefinedEnvironment>	userEnvironmentMap Map of user-defined environments, keyed on name

Access	Constructor and Description
pack-priv	SnuggleSession(final SnuggleEngine engine, final SessionConfiguration configuration) (This package-private constructor is used when creating a new session via `SnuggleEngine#createSession()` et al.)
pack-priv	SnuggleSession(final SnuggleSnapshot snapshot) (This package-private constructor is used when creating a session from an existing `SnuggleSnapshot` via `SnuggleSnapshot#createSession()`.)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildDOMSubtree(final Element targetRoot, final DOMOutputOptions options) Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element.
public boolean	Returns: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildDOMSubtree(final Element targetRoot) Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element.
public NodeList	Returns: resulting `NodeList` if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildDOMSubtree() Convenience method to build a DOM `NodeList` representing the converted Tokens.
public NodeList	Returns: resulting `NodeList` if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildDOMSubtree(final DOMOutputOptions `DOMOutputOptions` to use, which must not be null options) Convenience method to build a DOM `NodeList` representing the converted Tokens.
public Document	Returns: resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildWebPage(final WebPageOutputOptions options) Builds a complete web page based on the currently parsed tokens, returning a DOM `Document` Object.
public String	Returns: resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildWebPageString(final WebPageOutputOptions options) Builds a complete web page based on the currently parsed tokens, returning a String containing the resulting content.
public String	Returns: resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildXMLString() Creates a well-formed external general parsed entity out of the currently parsed tokens.
public String	Returns: resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildXMLString(final XMLStringOutputOptions `XMLStringOutputOptions` to use, which must not be null. options) Creates a well-formed external general parsed entity out of the currently parsed tokens.
public String	Returns: resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildXMLString(boolean whether to indent the resulting XML or not indent) Deprecated Use `buildXMLString(XMLStringOutputOptions)` instead Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.
public String	Returns: resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildXMLString(final DOMOutputOptions options) Deprecated Use `buildXMLString(XMLStringOutputOptions)` instead. Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.
public String	Returns: resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. buildXMLString(final DOMOutputOptions options, final boolean whether to indent the resulting XML or not indent) Deprecated Use `buildXMLString(XMLStringOutputOptions)` instead. Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.
public SnuggleSnapshot	createSnapshot() Creates a `SnuggleSnapshot` Object holding the current state of this session that can be later used to recreate a session having exactly the same state.
public Document	createWebPage(final WebPageOutputOptions options) Deprecated For naming consistency, please use `buildWebPage(WebPageOutputOptions)` instead.
public BuiltinCommand	getBuiltinCommandByTeXName(String texName) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getBuiltinCommandByTeXName. Returns the `BuiltinCommand` corresponding to LaTeX command called `\texName`, or null if this command is not defined.
public BuiltinEnvironment	getBuiltinEnvironmentByTeXName(String texName) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getBuiltinEnvironmentByTeXName. Returns the `BuiltinEnvironment` corresponding to LaTeX environment called `texName`, or null if this environment is not defined.
public SessionConfiguration	getConfiguration() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getConfiguration.
public List<InputError>	getErrors() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getErrors.
public MathCharacter	getMathCharacter(int codePoint) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getMathCharacter.
public List<FlowToken>	getParsedTokens()
public StylesheetManager	getStylesheetManager() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getStylesheetManager. Gets the `StylesheetManager` being used by the underlying `SnuggleEngine`
public Map<String, UserDefinedCommand>	getUserCommandMap() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getUserCommandMap. Gets the `Map` of all user-defined commands created in this session.
public Map<String, UserDefinedEnvironment>	getUserEnvironmentMap() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getUserEnvironmentMap. Gets the `Map` of all user-defined environments created in this session.
public boolean	Returns: true if parsing finished, false if it was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. parseInput(SnuggleInput input to parse, which must not be null snuggleInput) Parses the data contained within the given `SnuggleInput`, and performs fixing on the resulting tokens.
public void	registerError(InputError `InputError` to register, which must not be null. inputError) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.registerError. Records a new error, throwing a `SnuggleParseException` if the current `SessionConfiguration` deems that we should fail on the first error.
public void	reset() Resets this `SnuggleSession` back to an initial blank state
public void	setWebPageContentType(final WebPageOutputOptions options, final Object contentTypeSettable) Calls the `setContentType` of the given Object to something appropriate for the given `WebPageOutputOptions`.
public boolean	Returns: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. writeWebPage(final WebPageOutputOptions options, final OutputStream outputStream) Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream`, which is closed afterwards.
public boolean	Returns: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. writeWebPage(final WebPageOutputOptions options, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputAction) Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream` and performing the given `EndOutputAction` to it afterwards (i.e. close, flush or do nothing).
public boolean	Returns: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. writeWebPage(final WebPageOutputOptions options, final Object contentTypeSettable, final OutputStream outputStream) Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream`, which is closed afterwards.
public boolean	Returns: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. writeWebPage(final WebPageOutputOptions options, final Object contentTypeSettable, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputAction) Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream` and performing the given `EndOutputAction` to it afterwards (i.e. close, flush or do nothing).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

configuration	back to summary
private final SessionConfiguration configuration Configuration for this session

defaultDOMOutputOptions	back to summary
pack-priv final DOMOutputOptions defaultDOMOutputOptions Default `DOMOutputOptions`, copied from the owning `SnuggleEngine` during creation

defaultXMLStringOutputOptions	back to summary
pack-priv final XMLStringOutputOptions defaultXMLStringOutputOptions Default `XMLStringOutputOptions`, copied from the owning `SnuggleEngine` during creation

engine	back to summary
private final SnuggleEngine engine Engine that created this Session

errors	back to summary
private final List<InputError> errors Errors accumulated during this session

packages	back to summary
private final SnugglePackage[] packages Copy of the List of all currently registered `SnugglePackage`s used by the underlying Engine. As this is read-only as far as the session is concerned, we don't have to worry about synchronizing.

parsedTokens	back to summary
private final List<FlowToken> parsedTokens All tokens currently completely parsed (and fixed) by this session

styleEvaluator	back to summary
private final StyleEvaluator styleEvaluator

styleRebuilder	back to summary
private final StyleRebuilder styleRebuilder

tokenFixer	back to summary
private final TokenFixer tokenFixer `TokenFixer` used to massage inputs after parsing

tokeniser	back to summary
private final LaTeXTokeniser tokeniser `LaTeXTokeniser` used to parse inputs

userCommandMap	back to summary
private final Map<String, UserDefinedCommand> userCommandMap Map of user-defined commands, keyed on name

userEnvironmentMap	back to summary
private final Map<String, UserDefinedEnvironment> userEnvironmentMap Map of user-defined environments, keyed on name

SnuggleSession	back to summary
pack-priv SnuggleSession(final SnuggleEngine engine, final SessionConfiguration configuration) (This package-private constructor is used when creating a new session via `SnuggleEngine#createSession()` et al.)

SnuggleSession	back to summary
pack-priv SnuggleSession(final SnuggleSnapshot snapshot) (This package-private constructor is used when creating a session from an existing `SnuggleSnapshot` via `SnuggleSnapshot#createSession()`.)

Method Detail

buildDOMSubtree back to summary

buildDOMSubtree	back to summary
public boolean buildDOMSubtree(final Element targetRoot, final DOMOutputOptions options) Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element. The given `DOMOutputOptions` Object is used to configure the process. If the `DOMOutputOptions` specifies that MathML should be down-converted to XHTML where possible, then this will also happen. Returns:boolean true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public boolean buildDOMSubtree(final Element targetRoot, final DOMOutputOptions options)

Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element. The given DOMOutputOptions Object is used to configure the process.

If the DOMOutputOptions specifies that MathML should be down-converted to XHTML where possible, then this will also happen.

Returns:boolean: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildDOMSubtree back to summary

buildDOMSubtree	back to summary
public boolean buildDOMSubtree(final Element targetRoot) Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element. This uses the default `DOMOutputOptions` associated with this engine. Returns:boolean true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public boolean buildDOMSubtree(final Element targetRoot)

Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element. This uses the default DOMOutputOptions associated with this engine.

Returns:boolean: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildDOMSubtree back to summary

buildDOMSubtree	back to summary
public NodeList buildDOMSubtree() Convenience method to build a DOM `NodeList` representing the converted Tokens. These Nodes will belong to a "fake root" element in the `SnuggleConstants#SNUGGLETEX_NAMESPACE` namespace called "root". The default `DOMOutputOptions` specified in the `SnuggleEngine` will be used. Returns:NodeList resulting `NodeList` if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public NodeList buildDOMSubtree()

Convenience method to build a DOM NodeList representing the converted Tokens. These Nodes will belong to a "fake root" element in the SnuggleConstants#SNUGGLETEX_NAMESPACE namespace called "root".

The default DOMOutputOptions specified in the SnuggleEngine will be used.

Returns:NodeList: resulting NodeList if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildDOMSubtree back to summary

buildDOMSubtree	back to summary
public NodeList buildDOMSubtree(final DOMOutputOptions options) Convenience method to build a DOM `NodeList` representing the converted Tokens. These Nodes will belong to a "fake root" element in the `SnuggleConstants#SNUGGLETEX_NAMESPACE` namespace called "root". The given `DOMOutputOptions` Object is used to configure the process, which must not be null. Parameters options:DOMOutputOptions `DOMOutputOptions` to use, which must not be null Returns:NodeList resulting `NodeList` if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public NodeList buildDOMSubtree(final DOMOutputOptions options)

The given DOMOutputOptions Object is used to configure the process, which must not be null.

Parameters

options:DOMOutputOptions: DOMOutputOptions to use, which must not be null

Returns:NodeList

resulting NodeList if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildWebPage back to summary

buildWebPage	back to summary
public Document buildWebPage(final WebPageOutputOptions options) Builds a complete web page based on the currently parsed tokens, returning a DOM `Document` Object. The provided `WebPageOutputOptions` Object is used to determine which type of web page to generate and how it should be configured. Any XSLT stylesheet specified by `WebPageOutputOptions#getStylesheets()` will have been applied to the result before it is returned. On the other hand, serialisation options in the `WebPageOutputOptions` (such as Content Type and encoding) will not have been applied when this method returns. Returns:Document resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public Document buildWebPage(final WebPageOutputOptions options)

Builds a complete web page based on the currently parsed tokens, returning a DOM Document Object.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Any XSLT stylesheet specified by WebPageOutputOptions#getStylesheets() will have been applied to the result before it is returned. On the other hand, serialisation options in the WebPageOutputOptions (such as Content Type and encoding) will not have been applied when this method returns.

Returns:Document: resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildWebPageString back to summary

buildWebPageString	back to summary
public String buildWebPageString(final WebPageOutputOptions options) Builds a complete web page based on the currently parsed tokens, returning a String containing the resulting content. This is a convenience method; using `writeWebPage(WebPageOutputOptions, OutputStream)` might be more efficient. The provided `WebPageOutputOptions` Object is used to determine which type of web page to generate and how it should be configured. Any XSLT stylesheet specified by `WebPageOutputOptions#getStylesheets()` will have been applied to the result before it is returned. On the other hand, serialisation options in the `WebPageOutputOptions` (such as Content Type and encoding) will not have been applied when this method returns. Returns:String resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Since 1.3.0

public String buildWebPageString(final WebPageOutputOptions options)

Builds a complete web page based on the currently parsed tokens, returning a String containing the resulting content. This is a convenience method; using writeWebPage(WebPageOutputOptions, OutputStream) might be more efficient.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Returns:String: resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.
Since: 1.3.0

buildXMLString back to summary

buildXMLString	back to summary
public String buildXMLString() Creates a well-formed external general parsed entity out of the currently parsed tokens. The default `XMLStringOutputOptions` specified in the `SnuggleEngine` will be used. Returns:String resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public String buildXMLString()

Creates a well-formed external general parsed entity out of the currently parsed tokens.

The default XMLStringOutputOptions specified in the SnuggleEngine will be used.

Returns:String: resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString back to summary

buildXMLString	back to summary
public String buildXMLString(final XMLStringOutputOptions options) Creates a well-formed external general parsed entity out of the currently parsed tokens. The given `XMLStringOutputOptions` Object is used to configure the process. Parameters options:XMLStringOutputOptions `XMLStringOutputOptions` to use, which must not be null. Returns:String resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public String buildXMLString(final XMLStringOutputOptions options)

Creates a well-formed external general parsed entity out of the currently parsed tokens.

The given XMLStringOutputOptions Object is used to configure the process.

Parameters

options:XMLStringOutputOptions: XMLStringOutputOptions to use, which must not be null.

Returns:String

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString back to summary

buildXMLString	back to summary
public String buildXMLString(boolean indent) Deprecated Use `buildXMLString(XMLStringOutputOptions)` instead Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens. The default `DOMOutputOptions` specified in the `SnuggleEngine` will be used. Parameters indent:boolean whether to indent the resulting XML or not Returns:String resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Annotations @Deprecated

public String buildXMLString(boolean indent)

Deprecated

Use buildXMLString(XMLStringOutputOptions) instead

Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.

The default DOMOutputOptions specified in the SnuggleEngine will be used.

Parameters

indent:boolean: whether to indent the resulting XML or not

Returns:String

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

Annotations

@Deprecated

buildXMLString back to summary

buildXMLString	back to summary
public String buildXMLString(final DOMOutputOptions options) Deprecated Use `buildXMLString(XMLStringOutputOptions)` instead. Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens. The given `DOMOutputOptions` Object is used to configure the process. Returns:String resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Annotations @Deprecated

public String buildXMLString(final DOMOutputOptions options)

Deprecated

Use buildXMLString(XMLStringOutputOptions) instead.

Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.

The given DOMOutputOptions Object is used to configure the process.

Returns:String

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

Annotations

@Deprecated

buildXMLString back to summary

buildXMLString	back to summary
public String buildXMLString(final DOMOutputOptions options, final boolean indent) Deprecated Use `buildXMLString(XMLStringOutputOptions)` instead. Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens. The given `DOMOutputOptions` Object is used to configure the process. Parameters indent:boolean whether to indent the resulting XML or not Returns:String resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Annotations @Deprecated

public String buildXMLString(final DOMOutputOptions options, final boolean indent)

Deprecated

Use buildXMLString(XMLStringOutputOptions) instead.

Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.

The given DOMOutputOptions Object is used to configure the process.

Parameters

indent:boolean: whether to indent the resulting XML or not

Returns:String

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

Annotations

@Deprecated

createSnapshot	back to summary
public SnuggleSnapshot createSnapshot() Creates a `SnuggleSnapshot` Object holding the current state of this session that can be later used to recreate a session having exactly the same state.

createWebPage back to summary

createWebPage	back to summary
public Document createWebPage(final WebPageOutputOptions options) Deprecated For naming consistency, please use `buildWebPage(WebPageOutputOptions)` instead. Annotations @Deprecated

public Document createWebPage(final WebPageOutputOptions options)

Deprecated

For naming consistency, please use buildWebPage(WebPageOutputOptions) instead.

Annotations

@Deprecated

getBuiltinCommandByTeXName back to summary

getBuiltinCommandByTeXName	back to summary
public BuiltinCommand getBuiltinCommandByTeXName(String texName) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getBuiltinCommandByTeXName. Returns the `BuiltinCommand` corresponding to LaTeX command called `\texName`, or null if this command is not defined.

public BuiltinCommand getBuiltinCommandByTeXName(String texName)

Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getBuiltinCommandByTeXName.

Returns the BuiltinCommand corresponding to LaTeX command called \texName, or null if this command is not defined.

getBuiltinEnvironmentByTeXName back to summary

getBuiltinEnvironmentByTeXName	back to summary
public BuiltinEnvironment getBuiltinEnvironmentByTeXName(String texName) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getBuiltinEnvironmentByTeXName. Returns the `BuiltinEnvironment` corresponding to LaTeX environment called `texName`, or null if this environment is not defined.

public BuiltinEnvironment getBuiltinEnvironmentByTeXName(String texName)

Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getBuiltinEnvironmentByTeXName.

Returns the BuiltinEnvironment corresponding to LaTeX environment called texName, or null if this environment is not defined.

getConfiguration	back to summary
public SessionConfiguration getConfiguration() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getConfiguration.

getErrors	back to summary
public List<InputError> getErrors() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getErrors.

getMathCharacter	back to summary
public MathCharacter getMathCharacter(int codePoint) Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getMathCharacter.

getParsedTokens	back to summary
public List<FlowToken> getParsedTokens()

getStylesheetManager back to summary

getStylesheetManager	back to summary
public StylesheetManager getStylesheetManager() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getStylesheetManager. Gets the `StylesheetManager` being used by the underlying `SnuggleEngine`

public StylesheetManager getStylesheetManager()

Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getStylesheetManager.

Gets the StylesheetManager being used by the underlying SnuggleEngine

getUserCommandMap back to summary

getUserCommandMap	back to summary
public Map<String, UserDefinedCommand> getUserCommandMap() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getUserCommandMap. Gets the `Map` of all user-defined commands created in this session.

public Map<String, UserDefinedCommand> getUserCommandMap()

Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getUserCommandMap.

Gets the Map of all user-defined commands created in this session.

getUserEnvironmentMap back to summary

getUserEnvironmentMap	back to summary
public Map<String, UserDefinedEnvironment> getUserEnvironmentMap() Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getUserEnvironmentMap. Gets the `Map` of all user-defined environments created in this session.

public Map<String, UserDefinedEnvironment> getUserEnvironmentMap()

Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.getUserEnvironmentMap.

Gets the Map of all user-defined environments created in this session.

parseInput back to summary

parseInput	back to summary
public boolean parseInput(SnuggleInput snuggleInput) throws IOException Parses the data contained within the given `SnuggleInput`, and performs fixing on the resulting tokens. Parameters snuggleInput:SnuggleInput input to parse, which must not be null Returns:boolean true if parsing finished, false if it was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public boolean parseInput(SnuggleInput snuggleInput) throws IOException

Parses the data contained within the given SnuggleInput, and performs fixing on the resulting tokens.

Parameters

snuggleInput:SnuggleInput: input to parse, which must not be null

Returns:boolean

true if parsing finished, false if it was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

registerError back to summary

registerError	back to summary
public void registerError(InputError inputError) throws SnuggleParseException Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.registerError. Records a new error, throwing a `SnuggleParseException` if the current `SessionConfiguration` deems that we should fail on the first error. Parameters inputError:InputError `InputError` to register, which must not be null. Exceptions SnuggleParseException: if this session is configured to fail fast

public void registerError(InputError inputError) throws SnuggleParseException

Implements uk.ac.ed.ph.snuggletex.internal.SessionContext.registerError.

Records a new error, throwing a SnuggleParseException if the current SessionConfiguration deems that we should fail on the first error.

Parameters

inputError:InputError: InputError to register, which must not be null.

Exceptions

SnuggleParseException:: if this session is configured to fail fast

reset	back to summary
public void reset() Resets this `SnuggleSession` back to an initial blank state

setWebPageContentType back to summary

setWebPageContentType	back to summary
public void setWebPageContentType(final WebPageOutputOptions options, final Object contentTypeSettable) Calls the `setContentType` of the given Object to something appropriate for the given `WebPageOutputOptions`. This may be useful in some cases. The main example for this would be passing a `javax.servlet.http.HttpResponse` Object, which I want to avoid a compile-time dependency on. See Also `writeWebPage(WebPageOutputOptions, Object, OutputStream)`

public void setWebPageContentType(final WebPageOutputOptions options, final Object contentTypeSettable)

Calls the setContentType of the given Object to something appropriate for the given WebPageOutputOptions. This may be useful in some cases.

The main example for this would be passing a javax.servlet.http.HttpResponse Object, which I want to avoid a compile-time dependency on.

See Also: writeWebPage(WebPageOutputOptions, Object, OutputStream)

writeWebPage back to summary

writeWebPage	back to summary
public boolean writeWebPage(final WebPageOutputOptions options, final OutputStream outputStream) throws IOException Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream`, which is closed afterwards. The provided `WebPageOutputOptions` Object is used to determine which type of web page to generate and how it should be configured. Returns:boolean true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

public boolean writeWebPage(final WebPageOutputOptions options, final OutputStream outputStream) throws IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Returns:boolean: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

writeWebPage back to summary

writeWebPage	back to summary
public boolean writeWebPage(final WebPageOutputOptions options, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputAction) throws IOException Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream` and performing the given `EndOutputAction` to it afterwards (i.e. close, flush or do nothing). The provided `WebPageOutputOptions` Object is used to determine which type of web page to generate and how it should be configured. Returns:boolean true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Since 1.2.2

public boolean writeWebPage(final WebPageOutputOptions options, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputAction) throws IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given EndOutputAction to it afterwards (i.e. close, flush or do nothing).

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Returns:boolean: true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.
Since: 1.2.2

writeWebPage back to summary

writeWebPage	back to summary
public boolean writeWebPage(final WebPageOutputOptions options, final Object contentTypeSettable, final OutputStream outputStream) throws IOException Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream`, which is closed afterwards. The provided `WebPageOutputOptions` Object is used to determine which type of web page to generate and how it should be configured. If the `contentTypeSettable` Object has a property called `contentType`, then it is set in advance to the appropriate HTTP `Content-Type` header for the resulting page before the web page data is written. Returns:boolean true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Exceptions IOException: if an I/O problem arose whilst writing out the web page data. SnuggleRuntimeException: if calling `setContentType()` on the contentTypeSettable Object failed, with the underlying Exception wrapped up.

public boolean writeWebPage(final WebPageOutputOptions options, final Object contentTypeSettable, final OutputStream outputStream) throws IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

If the contentTypeSettable Object has a property called contentType, then it is set in advance to the appropriate HTTP Content-Type header for the resulting page before the web page data is written.

Returns:boolean

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

Exceptions

IOException:: if an I/O problem arose whilst writing out the web page data.
SnuggleRuntimeException:: if calling setContentType() on the contentTypeSettable Object failed, with the underlying Exception wrapped up.

writeWebPage back to summary

writeWebPage	back to summary
public boolean writeWebPage(final WebPageOutputOptions options, final Object contentTypeSettable, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputAction) throws IOException Builds a complete web page based on the currently parsed tokens, sending the results to the given `OutputStream` and performing the given `EndOutputAction` to it afterwards (i.e. close, flush or do nothing). The provided `WebPageOutputOptions` Object is used to determine which type of web page to generate and how it should be configured. If the `contentTypeSettable` Object has a property called `contentType`, then it is set in advance to the appropriate HTTP `Content-Type` header for the resulting page before the web page data is written. Returns:boolean true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error. Exceptions IOException: if an I/O problem arose whilst writing out the web page data. SnuggleRuntimeException: if calling `setContentType()` on the contentTypeSettable Object failed, with the underlying Exception wrapped up. Since 1.2.2

public boolean writeWebPage(final WebPageOutputOptions options, final Object contentTypeSettable, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputAction) throws IOException

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Returns:boolean

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

Exceptions

IOException:: if an I/O problem arose whilst writing out the web page data.
SnuggleRuntimeException:: if calling setContentType() on the contentTypeSettable Object failed, with the underlying Exception wrapped up.

Since

1.2.2

Modifier and Type	Field and Description
public static final SnuggleSession.EndOutputAction	CLOSE Closes the `OutputStream` after writing
public static final SnuggleSession.EndOutputAction	DO_NOTHING Does nothing after writing
public static final SnuggleSession.EndOutputAction	FLUSH Flushes the `OutputStream` after writing

Modifier and Type	Method and Description
public static SnuggleSession.EndOutputAction	valueOf(String name)
public static SnuggleSession.EndOutputAction[]	values()

public final Class SnuggleSession

Usage

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SnuggleSession.EndOutputAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail