AbstractMain (JSimpleDB Application Classes 3.5.1 API)

java.lang.Object
- org.dellroad.stuff.main.MainClass
- - org.jsimpledb.app.AbstractMain

```
public abstract class AbstractMain
extends MainClass
```
Support superclass for main entry point classes of JSimpleDB-related applications.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowNewSchema`
`protected String`	`databaseDescription`
`protected HashSet<Class<? extends FieldType<?>>>`	`fieldTypeClasses`
`protected KVDatabase`	`kvdb`
`protected boolean`	`readOnly`
`protected HashSet<Class<?>>`	`schemaClasses`
`protected int`	`schemaVersion`
`protected boolean`	`verbose`

Fields inherited from class org.dellroad.stuff.main.MainClass
console, log

Constructor Summary

Constructors
Constructor and Description

AbstractMain()

Constructors
Constructor and Description
`AbstractMain()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`appendClasspath(String path)` Append path(s) to the classpath.
`String`	`getDatabaseDescription()`
`JSimpleDBFactory`	`getJSimpleDBFactory(Database db)`
`protected abstract String`	`getName()`
`int`	`getSchemaVersion()`
`boolean`	`isAllowNewSchema()`
`boolean`	`isReadOnly()`
`protected Class<?>`	`loadClass(String className)` Load a class.
`protected void`	`outputFlags(String[][] subclassOpts)` Output usage message flag listing.
`protected boolean`	`parseOption(String option, ArrayDeque<String> params)` Subclass hook to parse unrecognized command line options.
`int`	`parseOptions(ArrayDeque<String> params)` Parse command line options.
`protected void`	`shutdownKVDatabase()` Shutdown the `KVDatabase`.
`protected Database`	`startupKVDatabase()` Start the `Database` based on the configured `KVDatabase` and `fieldTypeClasses` and return it.

Methods inherited from class org.dellroad.stuff.main.MainClass
commandLoop, doMain, errout, handleCommand, parsePropertyFlags, run, usageError, usageMessage

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

- Field Detail
  - schemaVersion
```
protected int schemaVersion
```
  - schemaClasses
```
protected HashSet<Class<?>> schemaClasses
```
  - fieldTypeClasses
```
protected HashSet<Class<? extends FieldType<?>>> fieldTypeClasses
```
  - allowNewSchema
```
protected boolean allowNewSchema
```
  - kvdb
```
protected KVDatabase kvdb
```
  - databaseDescription
```
protected String databaseDescription
```
  - verbose
```
protected boolean verbose
```
  - readOnly
```
protected boolean readOnly
```
- Constructor Detail
  - AbstractMain
```
public AbstractMain()
```
- Method Detail
  - parseOptions
```
public int parseOptions(ArrayDeque<String> params)
```
    Parse command line options.
    
    Parameters:
    
    params - command line parameters
    
    Returns:
    
    -1 to proceed, otherwise process exit value
  - getSchemaVersion
```
public int getSchemaVersion()
```
  - isAllowNewSchema
```
public boolean isAllowNewSchema()
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - getDatabaseDescription
```
public String getDatabaseDescription()
```
  - getJSimpleDBFactory
```
public JSimpleDBFactory getJSimpleDBFactory(Database db)
```
  - parseOption
```
protected boolean parseOption(String option,
                              ArrayDeque<String> params)
```
    Subclass hook to parse unrecognized command line options.
    
    Parameters:
    
    option - command line option (starting with `-')
    
    params - subsequent command line parameters
    
    Returns:
    
    true if successful, false otherwise
  - appendClasspath
```
protected boolean appendClasspath(String path)
```
    Append path(s) to the classpath.
    
    Parameters:
    
    path - classpath path component
    
    Returns:
    
    true if successful, false if an error occured
  - loadClass
```
protected Class<?> loadClass(String className)
```
    Load a class.
    
    Parameters:
    
    className - class name
    
    Returns:
    
    class with name className
    
    Throws:
    
    RuntimeException - if load fails
  - startupKVDatabase
```
protected Database startupKVDatabase()
```
    Start the Database based on the configured KVDatabase and fieldTypeClasses and return it.
    
    Returns:
    
    initialized database
  - shutdownKVDatabase
```
protected void shutdownKVDatabase()
```
    Shutdown the KVDatabase.
  - getName
```
protected abstract String getName()
```
  - outputFlags
```
protected void outputFlags(String[][] subclassOpts)
```
    Output usage message flag listing.
    
    Parameters:
    
    subclassOpts - array containing flag and description pairs

Class AbstractMain

Field Summary

Fields inherited from class org.dellroad.stuff.main.MainClass

Constructor Summary

Method Summary

Methods inherited from class org.dellroad.stuff.main.MainClass

Methods inherited from class java.lang.Object

Field Detail

schemaVersion

schemaClasses

fieldTypeClasses

allowNewSchema

kvdb

databaseDescription

verbose

readOnly

Constructor Detail

AbstractMain

Method Detail

parseOptions

getSchemaVersion

isAllowNewSchema

isReadOnly

getDatabaseDescription

getJSimpleDBFactory

parseOption

appendClasspath

loadClass

startupKVDatabase

shutdownKVDatabase

getName

outputFlags