org.opends.server.util.cli
Class ErrorStreamConsoleApplication

java.lang.Object
  extended by org.opends.server.util.cli.ConsoleApplication
      extended by org.opends.server.util.cli.ErrorStreamConsoleApplication

public class ErrorStreamConsoleApplication
extends ConsoleApplication

A console application decorator which redirects all output to the underlying application's error stream.


Field Summary
 
Fields inherited from class org.opends.server.util.cli.ConsoleApplication
CONFIRMATION_MAX_TRIES
 
Constructor Summary
ErrorStreamConsoleApplication(ConsoleApplication app)
          Creates a new console application instance which redirects all output to the underlying application's error stream.
 
Method Summary
 boolean isAdvancedMode()
          Indicates whether or not the user has requested advanced mode.
 boolean isInteractive()
          Indicates whether or not the user has requested interactive behavior.
 boolean isMenuDrivenMode()
          Indicates whether or not this console application is running in its menu-driven mode.
 boolean isQuiet()
          Indicates whether or not the user has requested quiet output.
 boolean isScriptFriendly()
          Indicates whether or not the user has requested script-friendly output.
 boolean isVerbose()
          Indicates whether or not the user has requested verbose output.
 
Methods inherited from class org.opends.server.util.cli.ConsoleApplication
askConfirmation, confirmAction, createAdministrativeContext, createInitialLdapContextInteracting, getErrorStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, printlnProgress, printProgress, 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

ErrorStreamConsoleApplication

public ErrorStreamConsoleApplication(ConsoleApplication app)
Creates a new console application instance which redirects all output to the underlying application's error stream.

Parameters:
app - The underlying application console.
Method Detail

isAdvancedMode

public boolean isAdvancedMode()
Indicates whether or not the user has requested advanced mode.

Specified by:
isAdvancedMode in class ConsoleApplication
Returns:
Returns true if the user has requested advanced mode.

isInteractive

public boolean isInteractive()
Indicates whether or not the user has requested interactive behavior.

Specified by:
isInteractive in class ConsoleApplication
Returns:
Returns true if the user has requested interactive behavior.

isMenuDrivenMode

public boolean isMenuDrivenMode()
Indicates whether or not 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 or not sub-menus should display a cancel option as well as a quit option.

Specified by:
isMenuDrivenMode in class ConsoleApplication
Returns:
Returns true if this console application is running in its menu-driven mode.

isQuiet

public boolean isQuiet()
Indicates whether or not the user has requested quiet output.

Specified by:
isQuiet in class ConsoleApplication
Returns:
Returns true if the user has requested quiet output.

isScriptFriendly

public boolean isScriptFriendly()
Indicates whether or not the user has requested script-friendly output.

Specified by:
isScriptFriendly in class ConsoleApplication
Returns:
Returns true if the user has requested script-friendly output.

isVerbose

public boolean isVerbose()
Indicates whether or not the user has requested verbose output.

Specified by:
isVerbose in class ConsoleApplication
Returns:
Returns true if the user has requested verbose output.