SnuggleEngine (SnuggleTeX Core 1.5.0-SNAPSHOT API)

java.lang.Object
- uk.ac.ed.ph.snuggletex.SnuggleEngine

```
public final class SnuggleEngine
extends Object
```
This is the main entry point into SnuggleTeX.
Usage
- Create an instance of this engine and register any extra SnugglePackages you have created or want to use by calling addPackage(SnugglePackage).
- Use createSession() to create a "session" that will take one (or more) input documents and produce a DOM.
- Each SnuggleSession created will use a _copy_ of the SnugglePackages registered with the engine and _copies_ of the current defaultSessionConfiguration, defaultDOMOutputOptions, and defaultXMLStringOutputOptions. On the other hand, it will use the shared StylesheetManager set for this engine.
- As of SnuggleTeX 1.3.0, an instance of this Class can be fully shared by multiple Threads.
- Don't let the usual connotations associated with the name of this Class worry you that instantiating it is going to be expensive!
Version:

$Revision$

Author:

David McKain

Constructor Summary

Constructors
Constructor and Description
`SnuggleEngine()` Creates a new `SnuggleEngine` using a very simple internal cache for any XSLT stylesheets required that simply stores them internally for the lifetime of the engine.
`SnuggleEngine(StylesheetCache stylesheetCache)` Creates a new `SnuggleEngine` using the given `StylesheetCache` for managing stylesheets.
`SnuggleEngine(StylesheetManager stylesheetManager)` Creates a new `SnuggleEngine` using the given `StylesheetManager` for managing stylesheets.
`SnuggleEngine(TransformerFactoryChooser transformerFactoryChooser, StylesheetCache stylesheetCache)` Creates a new `SnuggleEngine` using the given `StylesheetCache` for managing stylesheets and given `TransformerFactoryChooser` for choosing which XSLT implementation to use.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPackage(SnugglePackage snugglePackage)` Registers the given `SnugglePackage` with this `SnuggleEngine`.
`SnuggleSession`	`createSession()` Creates a new `SnuggleSession` using the default `SessionConfiguration` or a fresh `SessionConfiguration` if no default has been set.
`SnuggleSession`	`createSession(SessionConfiguration sessionConfiguration)` Creates a new `SnuggleSession` using the given `SessionConfiguration`
`SnuggleSimpleMathRunner`	`createSimpleMathRunner()`
`SnuggleSimpleMathRunner`	`createSimpleMathRunner(SessionConfiguration sessionConfiguration)`
`BuiltinCommand`	`getBuiltinCommandByTeXName(String texName)` Returns the `BuiltinCommand` corresponding to LaTeX command called `\texName`, or null if this command is not defined.
`BuiltinEnvironment`	`getBuiltinEnvironmentByTeXName(String texName)` Returns the `BuiltinEnvironment` corresponding to LaTeX environment called `texName`, or null if this environment is not defined.
`DOMOutputOptions`	`getDefaultDOMOptions()` Deprecated. Use `getDefaultDOMOutputOptions()`
`DOMOutputOptions`	`getDefaultDOMOutputOptions()` Gets the default `DOMOutputOptions` for this `SnuggleEngine`, which will not be null.
`SessionConfiguration`	`getDefaultSessionConfiguration()` Gets the selected default `SessionConfiguration` for this `SnuggleEngine`, which will not be null.
`XMLStringOutputOptions`	`getDefaultXMLStringOutputOptions()` Gets the default `XMLStringOutputOptions` for this `SnuggleEngine`, which will not be null.
`List<SnugglePackage>`	`getPackages()` Returns a synchronized `List` of all `SnugglePackage`s registered with this engine.
`StylesheetManager`	`getStylesheetManager()` Convenience method to extract the underlying `StylesheetManager` used by this engine.
`void`	`setDefaultDOMOptions(DOMOutputOptions defaultDOMOptions)` Deprecated. Use `setDefaultDOMOutputOptions(DOMOutputOptions)`
`void`	`setDefaultDOMOutputOptions(DOMOutputOptions defaultDOMOutputOptions)` Sets the default `DOMOutputOptions` for this `SnuggleEngine`.
`void`	`setDefaultSessionConfiguration(SessionConfiguration defaultSessionConfiguration)` Sets the default `SessionConfiguration` for this `SnuggleEngine`.
`void`	`setDefaultXMLStringOutputOptions(XMLStringOutputOptions defaultXMLOutputOptions)` Sets the default `XMLStringOutputOptions` for this `SnuggleEngine`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SnuggleEngine
```
public SnuggleEngine()
```
    Creates a new SnuggleEngine using a very simple internal cache for any XSLT stylesheets required that simply stores them internally for the lifetime of the engine. The DefaultTransformerFactoryChooser is used to choose XSLT implementations.
    This will be fine in most cases. If you want more control over this, consider the alternative constructor.
  - SnuggleEngine
```
public SnuggleEngine(StylesheetCache stylesheetCache)
```
    Creates a new SnuggleEngine using the given StylesheetCache for managing stylesheets. Use this if you want to integrate XSLT caching with your own code or want more control over how things get cached. The DefaultTransformerFactoryChooser is used to choose XSLT implementations.
  - SnuggleEngine
```
public SnuggleEngine(TransformerFactoryChooser transformerFactoryChooser,
                     StylesheetCache stylesheetCache)
```
    Creates a new SnuggleEngine using the given StylesheetCache for managing stylesheets and given TransformerFactoryChooser for choosing which XSLT implementation to use. Use this if you want to integrate XSLT caching with your own code, want more control over how things get cached or want to control the selection of XSLT implementations.
  - SnuggleEngine
```
public SnuggleEngine(StylesheetManager stylesheetManager)
```
    Creates a new SnuggleEngine using the given StylesheetManager for managing stylesheets. Use this if you want to integrate XSLT caching with your own code, want more control over how things get cached or want to control the selection of XSLT implementations.
- Method Detail
  - getStylesheetManager
```
public StylesheetManager getStylesheetManager()
```
    Convenience method to extract the underlying StylesheetManager used by this engine. Most people won't care about this, but it might be useful if you're trying to integrate stylesheet caching.
  - getPackages
```
public List<SnugglePackage> getPackages()
```
    Returns a synchronized List of all SnugglePackages registered with this engine.
    
    Since:
    
    1.3.0
  - addPackage
```
public void addPackage(SnugglePackage snugglePackage)
```
    Registers the given SnugglePackage with this SnuggleEngine. All commands, environments and error codes defined by the SnugglePackage will then become available for use.
  - createSession
```
public SnuggleSession createSession()
```
    Creates a new SnuggleSession using the default SessionConfiguration or a fresh SessionConfiguration if no default has been set.
  - createSession
```
public SnuggleSession createSession(SessionConfiguration sessionConfiguration)
```
    Creates a new SnuggleSession using the given SessionConfiguration
    
    Parameters:
    
    sessionConfiguration - SessionConfiguration to use, which must not be null.
  - createSimpleMathRunner
```
public SnuggleSimpleMathRunner createSimpleMathRunner()
```
  - createSimpleMathRunner
```
public SnuggleSimpleMathRunner createSimpleMathRunner(SessionConfiguration sessionConfiguration)
```
  - getBuiltinCommandByTeXName
```
public BuiltinCommand getBuiltinCommandByTeXName(String texName)
```
    Returns the BuiltinCommand corresponding to LaTeX command called \texName, or null if this command is not defined.
  - getBuiltinEnvironmentByTeXName
```
public BuiltinEnvironment getBuiltinEnvironmentByTeXName(String texName)
```
    Returns the BuiltinEnvironment corresponding to LaTeX environment called texName, or null if this environment is not defined.
  - getDefaultSessionConfiguration
```
public SessionConfiguration getDefaultSessionConfiguration()
```
    Gets the selected default SessionConfiguration for this SnuggleEngine, which will not be null.
  - setDefaultSessionConfiguration
```
public void setDefaultSessionConfiguration(SessionConfiguration defaultSessionConfiguration)
```
    Sets the default SessionConfiguration for this SnuggleEngine. This will be used when creating a new SnuggleSession via createSession().
    
    Parameters:
    
    defaultSessionConfiguration - new default SessionConfiguration, which must not be null.
  - getDefaultDOMOutputOptions
```
public DOMOutputOptions getDefaultDOMOutputOptions()
```
    Gets the default DOMOutputOptions for this SnuggleEngine, which will not be null.
  - setDefaultDOMOutputOptions
```
public void setDefaultDOMOutputOptions(DOMOutputOptions defaultDOMOutputOptions)
```
    Sets the default DOMOutputOptions for this SnuggleEngine. These will be used when calling SnuggleSession.buildDOMSubtree().
    
    Parameters:
    
    defaultDOMOutputOptions - new DOMOutputOptions, which must not be null.
  - getDefaultXMLStringOutputOptions
```
public XMLStringOutputOptions getDefaultXMLStringOutputOptions()
```
    Gets the default XMLStringOutputOptions for this SnuggleEngine, which will not be null.
  - setDefaultXMLStringOutputOptions
```
public void setDefaultXMLStringOutputOptions(XMLStringOutputOptions defaultXMLOutputOptions)
```
    Sets the default XMLStringOutputOptions for this SnuggleEngine. These will be used when calling SnuggleSession.buildXMLString().
    
    Parameters:
    
    defaultXMLOutputOptions - new XMLStringOutputOptions, which must not be null.
  - getDefaultDOMOptions
```
@Deprecated
public DOMOutputOptions getDefaultDOMOptions()
```
    Deprecated. Use getDefaultDOMOutputOptions()
  - setDefaultDOMOptions
```
@Deprecated
public void setDefaultDOMOptions(DOMOutputOptions defaultDOMOptions)
```
    Deprecated. Use setDefaultDOMOutputOptions(DOMOutputOptions)

Class SnuggleEngine

Usage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SnuggleEngine

SnuggleEngine

SnuggleEngine

SnuggleEngine

Method Detail

getStylesheetManager

getPackages

addPackage

createSession

createSession

createSimpleMathRunner

createSimpleMathRunner

getBuiltinCommandByTeXName

getBuiltinEnvironmentByTeXName

getDefaultSessionConfiguration

setDefaultSessionConfiguration

getDefaultDOMOutputOptions

setDefaultDOMOutputOptions

getDefaultXMLStringOutputOptions

setDefaultXMLStringOutputOptions

getDefaultDOMOptions

setDefaultDOMOptions