com.orientechnologies.common.console

Class OConsoleApplication

java.lang.Object

com.orientechnologies.common.console.OConsoleApplication

Direct Known Subclasses:

OrientConsole

public class OConsoleApplication
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OConsoleApplication.RESULT

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	args
protected StringBuilder	commandBuffer
protected static String[]	COMMENT_PREFIXS
protected PrintStream	err
protected String[]	exitCommands
protected String[]	helpCommands
protected InputStream	in
protected boolean	interactiveMode
protected TreeMap<Method,Object>	methods
static String	ONLINE_HELP_EXT
static String	ONLINE_HELP_URL
protected PrintStream	out
static String	PARAM_DISABLE_HISTORY
protected Map<String,String>	properties
protected OConsoleReader	reader
protected String	wordSeparator

Constructor Summary

Constructors

Constructor and Description
OConsoleApplication(String[] iArgs)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	addCommand(Map<String,Object> commandsTree, String commandLine)
void	error(String iMessage, Object... iArgs)
protected OConsoleApplication.RESULT	execute(String iCommand)
protected boolean	executeBatch(String commandLine)
protected boolean	executeCommands(OCommandStream commandStream, boolean iBatchMode)
protected String	formatCommandSpecs(String iCommand, Method m)
static String	getClearName(String iJavaName)
protected String	getCommandLine(String[] iArguments)
protected Map<Method,Object>	getConsoleMethods() Returns a map of all console method and the object they can be called on.
protected int	getConsoleWidth()
protected String	getContext()
static String	getCorrectMethodName(Method m)
protected Method	getMethod(String iCommand)
protected String	getOnlineHelp(String urlToRead)
protected String	getPrompt()
int	getVerboseLevel()
void	help(String iCommand)
protected boolean	isCollectingCommands(String iLine)
protected boolean	isComment(String commandLine)
boolean	isEchoEnabled()
protected static boolean	isInteractiveMode(String[] args)
protected boolean	isPropertyEnabled(String iPropertyName)
void	message(String iMessage, Object... iArgs)
protected void	onAfter()
protected void	onBefore()
protected void	onException(Throwable throwable)
int	run()
void	setOutput(PrintStream iOut)
void	setReader(OConsoleReader iReader)
protected void	syntaxError(String iCommand, Method m)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_DISABLE_HISTORY

public static final String PARAM_DISABLE_HISTORY

See Also:

Constant Field Values

ONLINE_HELP_URL

public static final String ONLINE_HELP_URL

See Also:

Constant Field Values

ONLINE_HELP_EXT

public static final String ONLINE_HELP_EXT

See Also:

Constant Field Values

COMMENT_PREFIXS

protected static final String[] COMMENT_PREFIXS

commandBuffer

protected final StringBuilder commandBuffer

in

protected InputStream in

out

protected PrintStream out

err

protected PrintStream err

wordSeparator

protected String wordSeparator

helpCommands

protected String[] helpCommands

exitCommands

protected String[] exitCommands

properties

protected Map<String,String> properties

reader

protected OConsoleReader reader

interactiveMode

protected boolean interactiveMode

args

protected String[] args

methods

protected TreeMap<Method,Object> methods

Constructor Detail

OConsoleApplication

public OConsoleApplication(String[] iArgs)

Method Detail

getCorrectMethodName

public static String getCorrectMethodName(Method m)

getClearName

public static String getClearName(String iJavaName)

setReader

public void setReader(OConsoleReader iReader)

run

public int run()

message

public void message(String iMessage,
                    Object... iArgs)

error

public void error(String iMessage,
                  Object... iArgs)

getVerboseLevel

public int getVerboseLevel()

getConsoleWidth

protected int getConsoleWidth()

isEchoEnabled

public boolean isEchoEnabled()

isPropertyEnabled

protected boolean isPropertyEnabled(String iPropertyName)

getPrompt

protected String getPrompt()

getContext

protected String getContext()

isInteractiveMode

protected static boolean isInteractiveMode(String[] args)

executeBatch

protected boolean executeBatch(String commandLine)

executeCommands

protected boolean executeCommands(OCommandStream commandStream,
                                  boolean iBatchMode)

isComment

protected boolean isComment(String commandLine)

isCollectingCommands

protected boolean isCollectingCommands(String iLine)

execute

protected OConsoleApplication.RESULT execute(String iCommand)

getMethod

protected Method getMethod(String iCommand)

syntaxError

protected void syntaxError(String iCommand,
                           Method m)

formatCommandSpecs

protected String formatCommandSpecs(String iCommand,
                                    Method m)

getConsoleMethods

protected Map<Method,Object> getConsoleMethods()

Returns a map of all console method and the object they can be called on.

Returns:

Map<Method,Object>

addCommand

protected Map<String,Object> addCommand(Map<String,Object> commandsTree,
                                        String commandLine)

help

public void help(String iCommand)

getCommandLine

protected String getCommandLine(String[] iArguments)

onBefore

protected void onBefore()

onAfter

protected void onAfter()

onException

protected void onException(Throwable throwable)

setOutput

public void setOutput(PrintStream iOut)

getOnlineHelp

protected String getOnlineHelp(String urlToRead)