net.nicholaswilliams.java.licensing.licensor.interfaces.cli.spi

Class ConsoleInterfaceDevice

java.lang.Object

net.nicholaswilliams.java.licensing.licensor.interfaces.spi.AbstractPasswordPrompter

net.nicholaswilliams.java.licensing.licensor.interfaces.cli.spi.AbstractTextInterfaceDevice

net.nicholaswilliams.java.licensing.licensor.interfaces.cli.spi.ConsoleInterfaceDevice

All Implemented Interfaces:

Flushable, TextInterfaceDevice, OutputDevice, PasswordPrompter

public class ConsoleInterfaceDevice
extends AbstractTextInterfaceDevice

The default implementation of TextInterfaceDevice. This is the only implementation currently used by the LicenseManager in production environments, and wraps all of the methods in Console and the exit method in Runtime.

Much of the documentation for the methods in this class was derived from the documentation for Console and Runtime because this implementation wraps the methods of those classes.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Field Summary

Fields inherited from class net.nicholaswilliams.java.licensing.licensor.interfaces.cli.spi.AbstractTextInterfaceDevice

err, in, out

Fields inherited from interface net.nicholaswilliams.java.licensing.licensor.interfaces.cli.spi.TextInterfaceDevice

CONSOLE

Constructor Summary

Constructors

Constructor and Description
ConsoleInterfaceDevice()

Method Summary

Methods

Modifier and Type	Method and Description
void	exit(int exitCode) Terminates the currently running application.
void	flush() Flushes this device by writing any buffered output to the underlying stream.
TextInterfaceDevice	format(String format, Object... arguments) Writes a formatted string to this device's output stream using the specified format string and arguments.
Console	getConsole() Gets the console object in use by this device.
Reader	getReader() Retrieves the unique Reader object associated with this interface device.
Runtime	getRuntime() Gets the runtime object in use by this device.
PrintWriter	getWriter() Retrieves the unique PrintWriter object associated with this interface device.
TextInterfaceDevice	printf(String format, Object... arguments) A convenience method to write a formatted string to this device's output stream using the specified format string and arguments.
String	readLine() Reads a single line of text from the device.
String	readLine(String format, Object... arguments) Provides a formatted prompt, then reads a single line of text from the device.
char[]	readPassword() Reads a password or passphrase from the device with echoing disabled.
char[]	readPassword(String format, Object... arguments) Provides a formatted prompt, then reads a password or passphrase from the device with echoing disabled.
void	registerShutdownHook(Thread hook) Registers a new application shutdown hook.
boolean	unregisterShutdownHook(Thread hook) De-registers a previously-registered application shutdown hook.

Methods inherited from class net.nicholaswilliams.java.licensing.licensor.interfaces.cli.spi.AbstractTextInterfaceDevice

err, exit, in, out, outputErrorMessage, outputMessage, printErr, printErr, printErr, printErrLn, printErrLn, printErrLn, printErrLn, printOut, printOut, printOut, printOutLn, printOutLn, printOutLn, printOutLn, promptForValidPassword

Methods inherited from class net.nicholaswilliams.java.licensing.licensor.interfaces.spi.AbstractPasswordPrompter

passwordsMatch, promptForValidPassword

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.nicholaswilliams.java.licensing.licensor.interfaces.spi.PasswordPrompter

passwordsMatch, promptForValidPassword

Constructor Detail

ConsoleInterfaceDevice

public ConsoleInterfaceDevice()

Method Detail

exit

public void exit(int exitCode)

Terminates the currently running application. The argument serves as a status code; by convention, a nonzero status code indicates abnormal termination.

Note: Wraps Runtime.exit(int).

Parameters:

exitCode - The exit status to exit with

registerShutdownHook

public void registerShutdownHook(Thread hook)
                          throws IllegalArgumentException,
                                 IllegalStateException,
                                 SecurityException

Registers a new application shutdown hook. For the standard behavior, implemented by this implementation, see the documentation for Runtime.addShutdownHook(Thread).

Note: Wraps Runtime.addShutdownHook(Thread).

Parameters:

hook - An initialized but unstarted Thread object

Throws:

IllegalArgumentException - if the specified hook has already been registered, or if it can be determined that the hook is already running or has already been run.

IllegalStateException - if the application is already in the process of shutting down.

SecurityException - if registering shutdown hooks is forbidden.

unregisterShutdownHook

public boolean unregisterShutdownHook(Thread hook)
                               throws IllegalStateException,
                                      SecurityException

De-registers a previously-registered application shutdown hook.

Note: Wraps Runtime.removeShutdownHook(Thread).

Parameters:

hook - The hook to remove

Returns:

true if the specified hook had previously been registered and was successfully de-registered, false otherwise

Throws:

IllegalStateException - if the virtual machine is already in the process of shutting down.

SecurityException - if registering shutdown hooks is forbidden.

format

public TextInterfaceDevice format(String format,
                         Object... arguments)
                           throws IllegalFormatException

Writes a formatted string to this device's output stream using the specified format string and arguments.

Note: Wraps Console.format(String, Object...).

Parameters:

format - A format string as described in #syntax

arguments - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

this device.

Throws:

IllegalFormatException - - if a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

printf

public TextInterfaceDevice printf(String format,
                         Object... arguments)
                           throws IllegalFormatException,
                                  IOError

A convenience method to write a formatted string to this device's output stream using the specified format string and arguments.

An invocation of this method of the form device.printf(format, args) behaves in exactly the same way as the invocation of device.format(format, args).

Note: Wraps Console.printf(String, Object...).

Parameters:

format - A format string as described in #syntax

arguments - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

this device.

Throws:

IllegalFormatException - if a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

IOError - if an I/O error occurs.

flush

public void flush()

Flushes this device by writing any buffered output to the underlying stream.

Note: Wraps Console.flush().

readLine

public String readLine()
                throws IOError

Reads a single line of text from the device.

Note: Wraps Console.readLine().

Returns:

a string containing the line read from the interface device input, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IOError - if an I/O error occurs.

readLine

public String readLine(String format,
              Object... arguments)
                throws IllegalFormatException,
                       IOError

Provides a formatted prompt, then reads a single line of text from the device.

Note: Wraps Console.readLine(String, Object...).

Parameters:

format - A format string as described in #syntax

arguments - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

a string containing the line read from the interface device input, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IllegalFormatException - if a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

IOError - if an I/O error occurs.

readPassword

public char[] readPassword()
                    throws IOError

Reads a password or passphrase from the device with echoing disabled.

Note: Wraps Console.readPassword().

Returns:

a character array containing the password or passphrase read from the device, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IOError - if an I/O error occurs.

readPassword

public char[] readPassword(String format,
                  Object... arguments)
                    throws IllegalFormatException,
                           IOError

Provides a formatted prompt, then reads a password or passphrase from the device with echoing disabled.

Note: Wraps Console.readPassword(String, Object...).

Parameters:

format - A format string as described in #syntax

arguments - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

a character array containing the password or passphrase read from the device, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IllegalFormatException - if a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

IOError - if an I/O error occurs.

getReader

public Reader getReader()

Retrieves the unique Reader object associated with this interface device. For more information regarding the uses of this method, see the documentation for Console.reader().

Note: Wraps Console.reader().

Returns:

the reader associated with this interface.

getWriter

public PrintWriter getWriter()

Retrieves the unique PrintWriter object associated with this interface device.

Note: Wraps Console.writer().

Returns:

the print writer associated with this interface.

getConsole

public Console getConsole()

Gets the console object in use by this device.

Returns:

the console object in use by this device.

getRuntime

public Runtime getRuntime()

Gets the runtime object in use by this device.

Returns:

the runtime object in use by this device.