de.vandermeer.skb.base.shell

Class SkbShellFactory

Object

SkbShellFactory

public class SkbShellFactory
extends Object

Factory for Skb Shell artifacts.

Since:

v0.0.10

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
static SkbShellCommandCategory	SIMPLE_COMMANDS A category for standard commands.

Constructor Summary

Constructors

Constructor and Description
SkbShellFactory()

Method Summary

Modifier and Type	Method and Description
static SkbShellArgument	newArgument(String argument, boolean isOptional, SkbShellArgumentType type, Object[] valueSet, String description, String addedHelp) Returns a new shell argument, use the factory to create one.
static SkbShellArgument[]	newArgumentArray(SkbShellArgument... args) Returns a new argument array.
static SkbShellCommandCategory	newCategory(String category, String description) Returns a new shell command category, use the SkbShellFactory to create a new object.
static SkbShellCommand	newCommand(String command, SkbShellArgument[] arguments, SkbShellCommandCategory category, String description, String addedHelp) Returns a new shell command, use the factory to create one.
static SkbShellCommand	newCommand(String command, SkbShellArgument argument, SkbShellCommandCategory category, String description, String addedHelp) Returns a new shell command, use the factory to create one.
static SkbShellCommand	newCommand(String command, SkbShellCommandCategory category, String description, String addedHelp) Returns a new shell command without formal arguments, use the factory to create one.
static SkbShell	newShell() Returns a new shell with the default identifier and the default STG and console activated.
static SkbShell	newShell(MessageRenderer renderer) Returns a new shell with the default identifier and the given STG and console activated.
static SkbShell	newShell(MessageRenderer renderer, boolean useConsole) Returns a new shell with given STG and console flag.
static SkbShell	newShell(String id) Returns a new shell with a given identifier, standard STGroup and console activated.
static SkbShell	newShell(String id, boolean useConsole) Returns a new shell with given identifier and console flag with standard STGroup.
static SkbShell	newShell(String id, MessageRenderer renderer) Returns a new shell with a given identifier and STGroup plus console activated.
static SkbShell	newShell(String id, MessageRenderer renderer, boolean useConsole) Returns a new shell with given identifier and console flag.

Methods inherited from class Object

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

Field Detail

SIMPLE_COMMANDS

public static SkbShellCommandCategory SIMPLE_COMMANDS

A category for standard commands.

Constructor Detail

SkbShellFactory

public SkbShellFactory()

Method Detail

newShell

public static SkbShell newShell()

Returns a new shell with the default identifier and the default STG and console activated.

Returns:

new shell

newShell

public static SkbShell newShell(MessageRenderer renderer)

Returns a new shell with the default identifier and the given STG and console activated.

Parameters:

renderer - a renderer for help messages

Returns:

new shell

newShell

public static SkbShell newShell(MessageRenderer renderer,
                                boolean useConsole)

Returns a new shell with given STG and console flag.

Parameters:

renderer - a renderer for help messages

useConsole - flag to use (true) or not to use (false) console, of false then no output will happen (except for errors on runShell() and some help commands)

Returns:

new shell

newShell

public static SkbShell newShell(String id)

Returns a new shell with a given identifier, standard STGroup and console activated.

Parameters:

id - new shell with identifier

Returns:

new shell

newShell

public static SkbShell newShell(String id,
                                boolean useConsole)

Returns a new shell with given identifier and console flag with standard STGroup.

Parameters:

id - new shell with identifier, uses default if given STG is not valid

useConsole - flag to use (true) or not to use (false) console, of false then no output will happen

Returns:

new shell

newShell

public static SkbShell newShell(String id,
                                MessageRenderer renderer)

Returns a new shell with a given identifier and STGroup plus console activated.

Parameters:

id - new shell with identifier

renderer - a renderer for help messages

Returns:

new shell

newShell

public static SkbShell newShell(String id,
                                MessageRenderer renderer,
                                boolean useConsole)

Returns a new shell with given identifier and console flag.

Parameters:

id - new shell with identifier

renderer - a renderer for help messages

useConsole - flag to use (true) or not to use (false) console, of false then no output will happen

Returns:

new shell

newCommand

public static SkbShellCommand newCommand(String command,
                                         SkbShellArgument[] arguments,
                                         SkbShellCommandCategory category,
                                         String description,
                                         String addedHelp)

Returns a new shell command, use the factory to create one.

Parameters:

command - the actual command

arguments - the command's arguments, can be null

category - the command's category, can be null

description - the command's description

addedHelp - additional help, can be null

Returns:

new shell command

Throws:

IllegalArgumentException - if command or description was null

newCommand

public static SkbShellCommand newCommand(String command,
                                         SkbShellArgument argument,
                                         SkbShellCommandCategory category,
                                         String description,
                                         String addedHelp)

Returns a new shell command, use the factory to create one.

Parameters:

command - the actual command

argument - the command's argument, can be null

category - the command's category, can be null

description - the command's description

addedHelp - additional help, can be null

Returns:

new shell command

Throws:

IllegalArgumentException - if command or description was null

newCommand

public static SkbShellCommand newCommand(String command,
                                         SkbShellCommandCategory category,
                                         String description,
                                         String addedHelp)

Returns a new shell command without formal arguments, use the factory to create one.

Parameters:

command - the actual command

category - the command's category, can be null

description - the command's description

addedHelp - additional help, can be null

Returns:

new shell command

Throws:

IllegalArgumentException - if command or description was null

newArgument

public static SkbShellArgument newArgument(String argument,
                                           boolean isOptional,
                                           SkbShellArgumentType type,
                                           Object[] valueSet,
                                           String description,
                                           String addedHelp)

Returns a new shell argument, use the factory to create one.

Parameters:

argument - the actual argument, cannot be blank

isOptional - flag for optional (true if optional, false if not)

type - the argument's type, cannot be null

valueSet - the argument's value set if specified, can be null

description - the command's description, cannot be null

addedHelp - a string additional to the description for help

Returns:

new shell argument

Throws:

IllegalArgumentException - if argument, type, or description was null

newArgumentArray

public static SkbShellArgument[] newArgumentArray(SkbShellArgument... args)

Returns a new argument array.

Parameters:

args - input arguments, any argument being null will be ignored

Returns:

argument array, null if none provided

newCategory

public static SkbShellCommandCategory newCategory(String category,
                                                  String description)

Returns a new shell command category, use the SkbShellFactory to create a new object.

Parameters:

category - the actual category

description - the command's description

Returns:

new shell command category

Throws:

IllegalArgumentException - if command or description was null