PepperStarter (pepper-lib 3.5.3 API)

java.lang.Object
- org.corpus_tools.pepper.cli.PepperStarter

```
public class PepperStarter
extends Object
```
The main class to start Pepper from the Console.

Author:

Florian

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PepperStarter.COMMAND

Nested Classes
Modifier and Type	Class and Description
`static class`	`PepperStarter.COMMAND`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONSOLE_WIDTH` The standard width of the output console of Pepper.
`static int`	`CONSOLE_WIDTH_120` The width of the output console of Pepper.
`static int`	`CONSOLE_WIDTH_80` The width of the output console of Pepper, when os is windows.
`static String`	`FILE_ENDING_PEPPER` This is the default ending of a Pepper workflow description file.
`static String`	`PROMPT`

Constructor Summary

Constructors
Constructor and Description
`PepperStarter()` Initializes an instance of PepperStarter without a `PepperConnector`.
`PepperStarter(PepperConnector pepperConnector)` Initializes an instance of PepperStarter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`clean()` Cleans the current Pepper instance and especially removes the OSGi workspace, to set up a new one.
`String`	`conf()`
`void`	`convert(String workFlowPath)` Loads the passed workflow description file and starts the conversion.
`String`	`debug()` Switches on/off the debug mode.
`String`	`fitness()` Returns a fitness report as a String.
`PepperConnector`	`getPepper()`
`PepperStarterConfiguration`	`getPepperConfiguration()`
`static String`	`getVersion()` Resolves the current Pepper version from a file named version.properties in the pepper-lib jar file.
`String`	`help()` Help to all commands for Pepper
`String`	`installAndStart(List<String> params)` Installs and starts a new Pepper module(s).
`String`	`list()` Returns a String containing a table with information about all available Pepper modules.
`String`	`list(String moduleSelector)` Returns a String containing a table with information about the passed Pepper module.
`static void`	`main(String[] args)`
`String`	`osgi()` Opens the OSGi console via an `OSGiConsole` object and delegates to it.
`String`	`remove(List<String> params)` Removes an existing Pepper module(s).
`void`	`runInteractive()` Starts the interactive console of Pepper.
`String`	`selfTest()` Deprecated.
`void`	`setPepper(PepperConnector pepper)` Sets a reference to Pepper via a `PepperConnector`
`void`	`setPepperConfiguration(PepperStarterConfiguration pepperConf)`
`String`	`start_osgi()` Starts the OSGi environment.
`String`	`stop_osgi()` Stops the OSGi environment.

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

- Field Detail
  - PROMPT
```
public static final String PROMPT
```
    See Also:
    
    Constant Field Values
  - FILE_ENDING_PEPPER
```
public static final String FILE_ENDING_PEPPER
```
    This is the default ending of a Pepper workflow description file.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_WIDTH
```
public static final int CONSOLE_WIDTH
```
    The standard width of the output console of Pepper.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_WIDTH_120
```
public static final int CONSOLE_WIDTH_120
```
    The width of the output console of Pepper.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_WIDTH_80
```
public static final int CONSOLE_WIDTH_80
```
    The width of the output console of Pepper, when os is windows.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PepperStarter
```
public PepperStarter()
```
    Initializes an instance of PepperStarter without a PepperConnector. Make sure to call method setPepper(PepperConnector) right after calling the constructor.
  - PepperStarter
```
public PepperStarter(PepperConnector pepperConnector)
```
    Initializes an instance of PepperStarter.
    
    Parameters:
    
    pepperConnector - a PepperConnector object via which the PepperStarter communicates with a Pepper instance
- Method Detail
  - getPepper
```
public PepperConnector getPepper()
```
    Returns:
    
    a reference to Pepper via a PepperConnector
  - setPepper
```
public void setPepper(PepperConnector pepper)
```
    Sets a reference to Pepper via a PepperConnector
  - getPepperConfiguration
```
public PepperStarterConfiguration getPepperConfiguration()
```
    Returns:
    
    configuration for PepperStarter
  - setPepperConfiguration
```
public void setPepperConfiguration(PepperStarterConfiguration pepperConf)
```
    Parameters:
    
    pepperConf - configuration for PepperStarter
  - help
```
public String help()
```
    Help to all commands for Pepper
    
    Returns:
  - list
```
public String list()
```
    Returns a String containing a table with information about all available Pepper modules.
    
    Returns:
  - list
```
public String list(String moduleSelector)
```
    Returns a String containing a table with information about the passed Pepper module.
    
    Parameters:
    
    moduleSelector - either the name of a module or the number of a module
    
    Returns:
  - start_osgi
```
public String start_osgi()
```
    Starts the OSGi environment.
  - stop_osgi
```
public String stop_osgi()
```
    Stops the OSGi environment.
  - clean
```
public String clean()
```
    Cleans the current Pepper instance and especially removes the OSGi workspace, to set up a new one.
    
    Returns:
  - debug
```
public String debug()
```
    Switches on/off the debug mode.
    
    Returns:
  - osgi
```
public String osgi()
```
    Opens the OSGi console via an OSGiConsole object and delegates to it.
  - convert
```
public void convert(String workFlowPath)
```
    Loads the passed workflow description file and starts the conversion.
    
    Parameters:
    
    workFlowPath -
  - installAndStart
```
public String installAndStart(List<String> params)
```
    Installs and starts a new Pepper module(s).
  - remove
```
public String remove(List<String> params)
```
    Removes an existing Pepper module(s).
  - selfTest
```
@Deprecated
public String selfTest()
```
    Deprecated.
    
    Calls PepperModule.isReadyToStart() for all Pepper modules.
    
    Returns:
  - fitness
```
public String fitness()
```
    Returns a fitness report as a String. This report contains a fitness value for each module and if a module is not fit, the report is expanded for a detailed report containing one value for each fitness feature.
    
    Returns:
    
    fitness report
  - conf
```
public String conf()
```
    Returns:
    
    a String containing all Pepper configurations formatted as table
  - runInteractive
```
public void runInteractive()
```
    Starts the interactive console of Pepper.
  - getVersion
```
public static String getVersion()
```
    Resolves the current Pepper version from a file named version.properties in the pepper-lib jar file.
    
    Returns:
    
    the current Pepper version
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Parameters:
    
    args -
    
    Throws:
    
    Exception

Class PepperStarter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROMPT

FILE_ENDING_PEPPER

CONSOLE_WIDTH

CONSOLE_WIDTH_120

CONSOLE_WIDTH_80

Constructor Detail

PepperStarter

PepperStarter

Method Detail

getPepper

setPepper

getPepperConfiguration

setPepperConfiguration

help

list

list

start_osgi

stop_osgi

clean

debug

osgi

convert

installAndStart

remove

selfTest

fitness

conf

runInteractive

getVersion

main