Package org.opends.guitools.uninstaller

Class UninstallCliHelper

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.guitools.uninstaller.UninstallCliHelper

public class UninstallCliHelper
extends ConsoleApplication

The class used to provide some CLI interface in the uninstall. This class basically is in charge of parsing the data provided by the user in the command line and displaying messages asking the user for information. Once the user has provided all the required information it calls Uninstaller and launches it.

Nested Class Summary

Nested classes/interfaces inherited from class com.forgerock.opendj.cli.ConsoleApplication

ConsoleApplication.Style

Constructor Summary

Constructors

Constructor	Description
UninstallCliHelper()	Default constructor.

Method Summary

Modifier and Type	Method	Description
UninstallUserData	createUserData(UninstallerArgumentParser args)	Creates a UserData based in the arguments provided.
boolean	isAdvancedMode()	Indicates whether the user has requested advanced mode.
boolean	isInteractive()	Indicates whether the user has requested interactive behavior.
boolean	isMenuDrivenMode()	Indicates whether this console application is running in its menu-driven mode.
boolean	isQuiet()	Indicates whether the user has requested quiet output.
boolean	isScriptFriendly()	Indicates whether the user has requested script-friendly output.
boolean	isVerbose()	Indicates whether the user has requested verbose output.

Methods inherited from class com.forgerock.opendj.cli.ConsoleApplication

askConfirmation, askPort, confirmAction, errPrint, errPrintln, errPrintln, errPrintln, errPrintVerboseMessage, getErrorStream, getErrStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, println, printlnNoWrap, printProgressBar, printVerboseMessage, readInput, readInput, readLineOfInput, readPassword, readPassword, readPort, readValidatedInput, readValidatedInput

Methods inherited from class java.lang.Object

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

Constructor Detail

UninstallCliHelper

public UninstallCliHelper()

Default constructor.

Method Detail

createUserData

public UninstallUserData createUserData(UninstallerArgumentParser args)
                                 throws UserDataException,
                                        ClientException

Creates a UserData based in the arguments provided. It asks user for additional information if what is provided in the arguments is not enough.

Parameters:

args - the ArgumentParser with the allowed arguments of the command line. The code assumes that the arguments have already been parsed.

Returns:

the UserData object with what the user wants to uninstall and null if the user cancels the uninstallation.

Throws:

UserDataException - if there is an error with the data in the arguments.

ClientException - If there is an error processing data in non-interactive mode and an error must be thrown (not in force on error mode).

isAdvancedMode

public boolean isAdvancedMode()

Description copied from class: ConsoleApplication

Indicates whether the user has requested advanced mode.

Overrides:

isAdvancedMode in class ConsoleApplication

Returns:

Returns true if the user has requested advanced mode.

isInteractive

public boolean isInteractive()

Description copied from class: ConsoleApplication

Indicates whether the user has requested interactive behavior. The default implementation returns true.

Overrides:

isInteractive in class ConsoleApplication

Returns:

true if the user has requested interactive behavior.

isMenuDrivenMode

public boolean isMenuDrivenMode()

Description copied from class: ConsoleApplication

Indicates whether this console application is running in its menu-driven mode. This can be used to dictate whether output should go to the error stream or not. In addition, it may also dictate whether sub-menus should display a cancel option as well as a quit option.

Overrides:

isMenuDrivenMode in class ConsoleApplication

Returns:

Returns true if this console application is running in its menu-driven mode.

isQuiet

public boolean isQuiet()

Description copied from class: ConsoleApplication

Indicates whether the user has requested quiet output. The default implementation returns false.

Overrides:

isQuiet in class ConsoleApplication

Returns:

true if the user has requested quiet output.

isScriptFriendly

public boolean isScriptFriendly()

Description copied from class: ConsoleApplication

Indicates whether the user has requested script-friendly output. The default implementation returns false.

Overrides:

isScriptFriendly in class ConsoleApplication

Returns:

true if the user has requested script-friendly output.

isVerbose

public boolean isVerbose()

Description copied from class: ConsoleApplication

Indicates whether the user has requested verbose output. The default implementation returns false.

Overrides:

isVerbose in class ConsoleApplication

Returns:

true if the user has requested verbose output.