JUnitSimulator (Scribble::Docs::Javadoc 0.3.0.Final API)

java.lang.Object
- org.scribble.trace.simulation.junit.JUnitSimulator

```
public class JUnitSimulator
extends Object
```
This class performs simulation of one or more trace files, and records the output in a JUnit XML file format.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`JUnitSimulator.JUnitSimulationListener` JUnit implementation of the simulation listener interface, used to record the intermediate and final results from simulating the trace files.

Constructor Summary

Constructors
Constructor and Description

JUnitSimulator()

Constructors
Constructor and Description
`JUnitSimulator()`

Method Summary

Methods
Modifier and Type	Method and Description
`ResourceLocator`	`getResourceLocator()` This method returns the resource locator.
`static void`	`initResultsFile(File file)` This method initialixes the result file.
`static void`	`main(String[] args)` This main method is invoked with the path of a single trace file, or a folder containing zero or more trace files.
`protected void`	`scanForTraceFiles(File file)` This method recursively processes a directory hierarchy locating 'trace' files, which are the simulated to produce results in the output file.
`void`	`setResourceLocator(ResourceLocator locator)` This method sets the resource locator.
`void`	`simulate(String path, String xmlFile)` This method simulates the trace file located at the specified path, or the zero or more trace files, if a directory is specified.
`protected void`	`simulateTrace(File traceFile)` This method simulates the supplied trace file.
`protected void`	`updateResultFile()` This method updates the results.
`static void`	`updateResultFile(File file, Document results)` This method updates the results from the junit document into the output (result) file.

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

- Constructor Detail
  - JUnitSimulator
```
public JUnitSimulator()
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    This main method is invoked with the path of a single trace file, or a folder containing zero or more trace files.
    
    Parameters:
    args - The path
  - setResourceLocator
```
public void setResourceLocator(ResourceLocator locator)
```
    This method sets the resource locator.
    
    Parameters:
    locator - The resource locator
  - getResourceLocator
```
public ResourceLocator getResourceLocator()
```
    This method returns the resource locator.
    
    Returns:
    The resource locator
  - simulate
```
public void simulate(String path,
            String xmlFile)
              throws Exception
```
    This method simulates the trace file located at the specified path, or the zero or more trace files, if a directory is specified. The results are recorded in the junit xml schema format in the file specified.
    
    Parameters:
    path - The trace(s) location
    xmlFile - The xml file to record the results
    
    Throws:
    
    Exception - Failed to simulate
  - scanForTraceFiles
```
protected void scanForTraceFiles(File file)
                          throws Exception
```
    This method recursively processes a directory hierarchy locating 'trace' files, which are the simulated to produce results in the output file.
    
    Parameters:
    file - The file
    
    Throws:
    
    Exception - Failed to simulate
  - simulateTrace
```
protected void simulateTrace(File traceFile)
                      throws Exception
```
    This method simulates the supplied trace file.
    
    Parameters:
    traceFile - The trace file
    
    Throws:
    
    Exception - Failed to simulate trace
  - initResultsFile
```
public static void initResultsFile(File file)
                            throws Exception
```
    This method initialixes the result file.
    
    Parameters:
    file - The file
    
    Throws:
    
    Exception - Failed to initialize
  - updateResultFile
```
protected void updateResultFile()
                         throws Exception
```
    This method updates the results.
    
    Throws:
    
    Exception - Failed to update
  - updateResultFile
```
public static void updateResultFile(File file,
                    Document results)
                             throws Exception
```
    This method updates the results from the junit document into the output (result) file.
    
    Parameters:
    file - The file
    results - The results
    
    Throws:
    
    Exception - Failed to update the result file

Class JUnitSimulator

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JUnitSimulator

Method Detail

main

setResourceLocator

getResourceLocator

simulate

scanForTraceFiles

simulateTrace

initResultsFile

updateResultFile

updateResultFile