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

public final Class SnuggleSnapshot

extends Object
Class Inheritance
Imports
java.util.List, .Map, uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommand, .UserDefinedEnvironment, uk.ac.ed.ph.snuggletex.tokens.FlowToken

A partial result of parsing one or more SnuggleInputs by a SnuggleSession, created via SnuggleSession#createSnapshot().

By calling createSession(), a new SnuggleSession with exactly the same state as this snapshot is created, which can then be used further.

Clients might want to use this if they always need to read in some local/configuration SnuggleInputs as it allows the results of these configurations to be reused without requiring re-parsing.

Author
David McKain
Version
$Revision:179 $

Field Summary

Modifier and TypeField and Description
pack-priv final SessionConfiguration
configuration

Configuration for the owning session

pack-priv final DOMOutputOptions
pack-priv final XMLStringOutputOptions
pack-priv final SnuggleEngine
pack-priv final List<InputError>
errors

Errors accumulated during the owning session

pack-priv final SnugglePackage[]
pack-priv final List<FlowToken>
parsedTokens

Parsing state for the owning session

pack-priv final Map<String, UserDefinedCommand>
userCommandMap

Map of user-defined commands, keyed on name

pack-priv final Map<String, UserDefinedEnvironment>
userEnvironmentMap

Map of user-defined environments, keyed on name

Constructor Summary

AccessConstructor and Description
pack-priv
SnuggleSnapshot(final SnuggleEngine engine, final SnugglePackage[] packages, final SessionConfiguration configuration, final DOMOutputOptions defaultDOMOutputOptions, final XMLStringOutputOptions defaultXMLStringOutputOptions, final List<InputError> errors, final Map<String, UserDefinedCommand> userCommandMap, final Map<String, UserDefinedEnvironment> userEnvironmentMap, final List<FlowToken> parsedTokens)

Method Summary

Modifier and TypeMethod and Description
public SnuggleSession
createSession()

Creates a new SnuggleSession with exactly the same state as the SnuggleSession that created this SnuggleSnapshot.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
pack-priv final SessionConfiguration configuration

Configuration for the owning session

defaultDOMOutputOptionsback to summary
pack-priv final DOMOutputOptions defaultDOMOutputOptions
defaultXMLStringOutputOptionsback to summary
pack-priv final XMLStringOutputOptions defaultXMLStringOutputOptions
engineback to summary
pack-priv final SnuggleEngine engine
errorsback to summary
pack-priv final List<InputError> errors

Errors accumulated during the owning session

packagesback to summary
pack-priv final SnugglePackage[] packages
parsedTokensback to summary
pack-priv final List<FlowToken> parsedTokens

Parsing state for the owning session

userCommandMapback to summary
pack-priv final Map<String, UserDefinedCommand> userCommandMap

Map of user-defined commands, keyed on name

userEnvironmentMapback to summary
pack-priv final Map<String, UserDefinedEnvironment> userEnvironmentMap

Map of user-defined environments, keyed on name

Constructor Detail

SnuggleSnapshotback to summary
pack-priv SnuggleSnapshot(final SnuggleEngine engine, final SnugglePackage[] packages, final SessionConfiguration configuration, final DOMOutputOptions defaultDOMOutputOptions, final XMLStringOutputOptions defaultXMLStringOutputOptions, final List<InputError> errors, final Map<String, UserDefinedCommand> userCommandMap, final Map<String, UserDefinedEnvironment> userEnvironmentMap, final List<FlowToken> parsedTokens)

Method Detail

createSessionback to summary
public SnuggleSession createSession()

Creates a new SnuggleSession with exactly the same state as the SnuggleSession that created this SnuggleSnapshot.