Package io.permazen.cli

Class PermazenShell

java.lang.Object

org.dellroad.jct.core.simple.SimpleCommandSupport

org.dellroad.jct.core.simple.SimpleShell

io.permazen.cli.PermazenShell

All Implemented Interfaces:

org.dellroad.jct.core.Shell

public class PermazenShell
extends org.dellroad.jct.core.simple.SimpleShell

A ShellSession that with an associated Permazen database.

Nested Class Summary

Nested classes/interfaces inherited from class org.dellroad.jct.core.simple.SimpleShell

org.dellroad.jct.core.simple.SimpleShell.Session, org.dellroad.jct.core.simple.SimpleShell.SimpleCompleter

Nested classes/interfaces inherited from class org.dellroad.jct.core.simple.SimpleCommandSupport

org.dellroad.jct.core.simple.SimpleCommandSupport.FoundCommand

Field Summary

Fields

Modifier and Type	Field	Description
protected final Database	db
protected final KVDatabase	kvdb
protected final Permazen	pdb

Fields inherited from class org.dellroad.jct.core.simple.SimpleCommandSupport

commandBundles, commandLineParser

Constructor Summary

Constructors

Constructor	Description
PermazenShell(Database db)
PermazenShell(KVDatabase kvdb)
PermazenShell(KVDatabase kvdb, Database db, Permazen pdb)	General constructor.
PermazenShell(Permazen pdb)

Method Summary

Modifier and Type	Method	Description
protected PermazenShellSession	createPermazenShellSession(org.dellroad.jct.core.ShellRequest request, org.jline.reader.LineReader reader)
protected Session	createSession(PermazenShellSession shellSession)
String	getContinuationPrompt()
String	getNormalPrompt()
PermazenShellSession	newShellSession(org.dellroad.jct.core.ShellRequest request)
final PermazenShellSession	newShellSession(org.dellroad.jct.core.ShellRequest request, org.jline.reader.LineReader reader)

Methods inherited from class org.dellroad.jct.core.simple.SimpleShell

buildLineReader, createLineReaderBuilder, getGreeting

Methods inherited from class org.dellroad.jct.core.simple.SimpleCommandSupport

buildCommandMap, findCommand, findCommand, findCommand, getCommandBundles, getCommandLineParser, setCommandLineParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

kvdb

protected final KVDatabase kvdb

db

protected final Database db

pdb

protected final Permazen pdb

Constructor Details

PermazenShell

public PermazenShell(KVDatabase kvdb)

PermazenShell

public PermazenShell(Database db)

PermazenShell

public PermazenShell(Permazen pdb)

PermazenShell

public PermazenShell(KVDatabase kvdb,
 Database db,
 Permazen pdb)

General constructor.

Exactly one of the three parameters must be non-null.

Parameters:

kvdb - key/value database

db - core API database

pdb - Java database

Throws:

IllegalArgumentException - if not exactly one parameter is non-null

Method Details

newShellSession

public PermazenShellSession newShellSession(org.dellroad.jct.core.ShellRequest request)
                                     throws IOException

Specified by:

newShellSession in interface org.dellroad.jct.core.Shell

Overrides:

newShellSession in class org.dellroad.jct.core.simple.SimpleShell

Throws:

IOException

newShellSession

public final PermazenShellSession newShellSession(org.dellroad.jct.core.ShellRequest request,
 org.jline.reader.LineReader reader)
                                           throws IOException

Overrides:

newShellSession in class org.dellroad.jct.core.simple.SimpleShell

Throws:

IOException

getNormalPrompt

public String getNormalPrompt()

Overrides:

getNormalPrompt in class org.dellroad.jct.core.simple.SimpleShell

getContinuationPrompt

public String getContinuationPrompt()

Overrides:

getContinuationPrompt in class org.dellroad.jct.core.simple.SimpleShell

createPermazenShellSession

protected PermazenShellSession createPermazenShellSession(org.dellroad.jct.core.ShellRequest request,
 org.jline.reader.LineReader reader)
                                                   throws IOException

Throws:

IOException

createSession

protected Session createSession(PermazenShellSession shellSession)