au.edu.swin.synergy.plugin.userdb
Class BUserDBCommand

java.lang.Object
  |
  +--au.edu.swin.synergy.plugin.userdb.BUserDBCommand

public class BUserDBCommand

extends Object

implements BOnCommand

This will simply allow the user to refresh the users and groups in memory with what is currently in the file.

Author:

Tristan Austin

Constructor Summary

BUserDBCommand(BUserDB userDB)
Creates a new user command object with the given user database to tell what to do

Method Summary

String	getHelp(BStringList paramaters) This method is called by the command line when the user types "help userdbreload"
int	onCommand(BStringList params, InputStream in, PrintStream out) When the user types the command associated with this on command class, this method will be called.

Methods inherited from class java.lang.Object

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

Constructor Detail

BUserDBCommand

public BUserDBCommand(BUserDB userDB)

Creates a new user command object with the given user database to tell what to do

Parameters:

userDB - The database to talk to

Method Detail

getHelp

public String getHelp(BStringList paramaters)

This method is called by the command line when the user types "help userdbreload"

Specified by:

getHelp in interface BOnCommand

Parameters:

paramaters - The paramaters to the help command

onCommand

public int onCommand(BStringList params,
                     InputStream in,
                     PrintStream out)

When the user types the command associated with this on command class, this method will be called. It contains a list of the paramaters the user presented as well as the input and output streams to workw with.

Specified by:

onCommand in interface BOnCommand

Parameters:

params - The parmaters given with the command

in - The input stream to read from if required

out - The output stream to write to

Returns:

An integer in the range Integer'range