com.github.croesch.micro_debug.argument
Class Help

java.lang.Object
  com.github.croesch.micro_debug.argument.AArgument
      com.github.croesch.micro_debug.argument.Help

public final class Help
extends AArgument

Argument to view a help about usage of the debugger

Since:

Date: Feb 28, 2012

Author:

croesch

Method Summary

boolean	execute(java.lang.String... params) Executes commands that result in the specific argument.
static Help	getInstance() The singleton instance of this argument.
protected java.lang.String	name() Returns the name of this argument containing only lower case characters and -.

Methods inherited from class com.github.croesch.micro_debug.argument.AArgument

createArgumentList, matches, of, releaseAllResources, values

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

@NotNull
public static Help getInstance()

The singleton instance of this argument.

Returns:

the single instance of this argument.

Since:

Date: Feb 28, 2012

execute

public boolean execute(java.lang.String... params)

Description copied from class: AArgument

Executes commands that result in the specific argument.

Specified by:

execute in class AArgument

Parameters:

params - the parameters of that argument, in case of the pseudo arguments (prefix ERROR_) this array contains the causes for the error.

Returns:

false, if the argument enforces the application to stop

name

@NotNull
protected java.lang.String name()

Description copied from class: AArgument

Returns the name of this argument containing only lower case characters and -.

Specified by:

name in class AArgument

Returns:

the name of this argument.