de.bsvrz.sys.funclib.losb.util.cmdinterface
Class Command

java.lang.Object
  extended by de.bsvrz.sys.funclib.losb.util.cmdinterface.Command
Direct Known Subclasses:
DataIdentInfo, HiddenCommand, ShowSubscriptionsCommand, ShutdownCommand

public abstract class Command
extends java.lang.Object

Abstrakte Klasse für Kommandos des CmdInterpreter

Version:
$Revision: 1.1 $ / $Date: 2008/01/22 16:55:53 $ / ($Author: yvonnes $)
Author:
beck et al. projects GmbH, Thomas Müller

Constructor Summary
Command(java.lang.String desc, java.lang.String help)
          Kommando für CmdInterpreter
 
Method Summary
abstract  void execute()
          Methode muss von einer implementierenden Klasse gefüllt werden
 java.lang.String getDesc()
          Beschreibung lesen
 java.lang.String getHelp()
          Hilfetext lesen
 int getIndex()
          Index des Kommandos auslesen
 CmdMenu getParent()
          Eltern-Menü für Kommando lesen
 void println(java.lang.String out)
          Ausgabe auf Client-Konsole (z.b.
 void printlnPlain(java.lang.String out)
          Ausgabe auf Client-Konsole (z.b.
 java.lang.String readln()
          Benutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)
 void setDesc(java.lang.String desc)
          Beschreibung setzen (wird im Menü in eckigen Klammern angezeigt)
 void setHelp(java.lang.String help)
          Hilfetext setzen
 void setIndex()
          Index des Kommandos setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen)
 void setParent(CmdMenu parent)
          Eltern-Menü für Kommando setzen
 void setStreams(java.io.BufferedReader in, java.io.BufferedWriter out)
          Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzen
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Command

public Command(java.lang.String desc,
               java.lang.String help)
Kommando für CmdInterpreter

Parameters:
desc - die Beschreibung
help - der Hilfetext
Method Detail

setStreams

public void setStreams(java.io.BufferedReader in,
                       java.io.BufferedWriter out)
Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzen

Parameters:
in - Eingabe-Reader
out - Ausgabe-Writer

getParent

public CmdMenu getParent()
Eltern-Menü für Kommando lesen

Returns:
Eltern-Menü

setParent

public void setParent(CmdMenu parent)
Eltern-Menü für Kommando setzen

Parameters:
parent - das Eltern-Menü

setIndex

public void setIndex()
Index des Kommandos setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen)


getIndex

public int getIndex()
Index des Kommandos auslesen

Returns:
Index (immer eindeutig in einem Menü)

setHelp

public void setHelp(java.lang.String help)
Hilfetext setzen

Parameters:
help - Hilfetext

getHelp

public java.lang.String getHelp()
Hilfetext lesen

Returns:
der Hilfetext

setDesc

public void setDesc(java.lang.String desc)
Beschreibung setzen (wird im Menü in eckigen Klammern angezeigt)

Parameters:
desc - Beschreibung

getDesc

public java.lang.String getDesc()
Beschreibung lesen

Returns:
die Beschreibung

readln

public java.lang.String readln()
                        throws java.lang.Exception
Benutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)

Returns:
userinput Benutzereingabe
Throws:
java.lang.Exception

println

public void println(java.lang.String out)
             throws java.lang.Exception
Ausgabe auf Client-Konsole (z.b. via Telnet)

Parameters:
out - der Ausgabe-String
Throws:
java.lang.Exception

printlnPlain

public void printlnPlain(java.lang.String out)
                  throws java.lang.Exception
Ausgabe auf Client-Konsole (z.b. via Telnet) ohne die aktuelle Option auszugeben

Parameters:
out - der Ausgabe-String
Throws:
java.lang.Exception

execute

public abstract void execute()
                      throws java.lang.Exception
Methode muss von einer implementierenden Klasse gefüllt werden

Throws:
java.lang.Exception - meist bei Server-Timeout (wird im CmdInterpreter abgefangen)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()


Copyright © 2005-2008 beck et al. projects GmbH All Rights Reserved.