Package de.svws_nrw.base.shell

Klasse CommandLineOption

java.lang.Object

de.svws_nrw.base.shell.CommandLineOption

public class CommandLineOption
extends Object

Diese Klasse repräsentiert eine Kommandozeilenoption

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CommandLineOption(String shortTag, String longTag, boolean hasArgument, String description)	Erzeugt eine neue Kommandozeilenoption.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getDescription()	Gibt die textuelle Beschreibung dieser Option zurück.
String	getLongTag()	Gibt die lange Bezeichnung für die Option zurück.
String	getShortTag()	Gibt die kurze Bezeichnung für die Option zurück.
boolean	hasArgument()	Gibt zurück, ob die Kommandozeilen-Option einen Parameter hat oder nicht.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

CommandLineOption

public CommandLineOption(String shortTag,
 String longTag,
 boolean hasArgument,
 String description)
                  throws CommandLineException

Erzeugt eine neue Kommandozeilenoption.

Parameter:

shortTag - die kurze Bezeichnung für die Option, wird mit einem einfachen Bindestrich verwendet

longTag - die lange Bezeichnung für die Option, wird mit zwei einfachen Bindestrichen verwendet

hasArgument - gibt an, ob nach der Bezeichnung für die Option ein Argument folgen muss oder nicht

description - eine textuelle Beschreibung dieser Option

Löst aus:

CommandLineException - falls die kurze oder die lange Bezeichnung null sind.

Methodendetails

getShortTag

public String getShortTag()

Gibt die kurze Bezeichnung für die Option zurück.

Gibt zurück:

die kurze Bezeichnung für die Option

getLongTag

public String getLongTag()

Gibt die lange Bezeichnung für die Option zurück.

Gibt zurück:

die lange Bezeichnung für die Option

hasArgument

public boolean hasArgument()

Gibt zurück, ob die Kommandozeilen-Option einen Parameter hat oder nicht.

Gibt zurück:

true, falls die Kommandozeilen-Option einen Parameter hat, ansonsten false

getDescription

public String getDescription()

Gibt die textuelle Beschreibung dieser Option zurück.

Gibt zurück:

die textuelle Beschreibung dieser Option