com.jmodule.exec

Class Module

java.lang.Object

com.jmodule.exec.Module

public class Module
extends java.lang.Object

Represents a module holding a group of possible commands relating to a certain function

Version:

1.3.1

Author:

Pierce Kelaita

Constructor Summary

Constructors

Constructor and Description
Module(java.lang.String name) Sets the name and the display promt that will come up on the CLI

Method Summary

Modifier and Type	Method and Description
void	addCommand(Command c) Adds to a list of commands that are only accessible when the user has switched to this module.
void	appendHelpPage(java.lang.String append) Adds additional information to the module's help page
java.util.ArrayList<Command>	getCommands()
java.lang.String	getName()
java.util.ArrayList<java.lang.String>	getReferences() Returns a list with the default reference of each command conatined within the module, plus 'help' and 'exit'
void	resetHelpPage(java.lang.String reset) Replaces the module's help page with a given String

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

public Module(java.lang.String name)

Sets the name and the display promt that will come up on the CLI

Parameters:

name -

Method Detail

getName

public java.lang.String getName()

getCommands

public java.util.ArrayList<Command> getCommands()

addCommand

public void addCommand(Command c)

Adds to a list of commands that are only accessible when the user has switched to this module.

Parameters:

c -

appendHelpPage

public void appendHelpPage(java.lang.String append)

Adds additional information to the module's help page

Parameters:

append - Information to append to help page

resetHelpPage

public void resetHelpPage(java.lang.String reset)

Replaces the module's help page with a given String

Parameters:

reset - New help page to display

getReferences

public java.util.ArrayList<java.lang.String> getReferences()

Returns a list with the default reference of each command conatined within the module, plus 'help' and 'exit'

Returns:

references