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

Class AbstractTextInterfaceDevice

java.lang.Object

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

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

All Implemented Interfaces:

Flushable, TextInterfaceDevice, OutputDevice, PasswordPrompter

Direct Known Subclasses:

ConsoleInterfaceDevice

public abstract class AbstractTextInterfaceDevice
extends AbstractPasswordPrompter
implements TextInterfaceDevice, PasswordPrompter, OutputDevice

An abstract implementation of TextInterfaceDevice that implements any common utilities among all interface devices.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Field Summary

Fields

Modifier and Type	Field and Description
protected PrintStream	err
protected InputStream	in
protected PrintStream	out

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

CONSOLE

Constructor Summary

Constructors

Constructor and Description
AbstractTextInterfaceDevice(InputStream inputStream, PrintStream outputStream, PrintStream errorStream)

Method Summary

Methods

Modifier and Type	Method and Description
PrintStream	err() Gets the standard error stream.
void	exit() Terminates the currently running application normally (with a status code of zero).
InputStream	in() Gets the standard input stream.
PrintStream	out() Gets the standard output stream.
void	outputErrorMessage(String message)
void	outputMessage(String message)
void	printErr(char c) Prints a char to standard-err.
void	printErr(Object o) Prints an Object to standard-out.
void	printErr(String s) Prints a String to standard-err.
void	printErrLn() Terminates the current standard-err line by writing the line separator string.
void	printErrLn(char c) Prints a char to standard-err, then terminates the current line by writing the line separator string.
void	printErrLn(Object o) Prints an Object to standard-err, then terminates the current line by writing the line separator string.
void	printErrLn(String s) Prints a String to standard-err, then terminates the current line by writing the line separator string.
void	printOut(char c) Prints a char to standard-out.
void	printOut(Object o) Prints an Object to standard-out.
void	printOut(String s) Prints a String to standard-out.
void	printOutLn() Terminates the current standard-out line by writing the line separator string.
void	printOutLn(char c) Prints a char to standard-out, then terminates the current line by writing the line separator string.
void	printOutLn(Object o) Prints an Object to standard-out, then terminates the current line by writing the line separator string.
void	printOutLn(String s) Prints a String to standard-out, then terminates the current line by writing the line separator string.
char[]	promptForValidPassword(int minLength, int maxLength, String what) Prompts for a valid password by asking for the password using PasswordPrompter.readPassword(String, Object...), checking its length against the constraints, asking for the password to be confirmed, and checking to make sure the passwords match.

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.cli.spi.TextInterfaceDevice

exit, format, getReader, getWriter, printf, readLine, readLine, readPassword, readPassword, registerShutdownHook, unregisterShutdownHook

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

passwordsMatch, promptForValidPassword

Methods inherited from interface java.io.Flushable

flush

Field Detail

in

protected final InputStream in

out

protected final PrintStream out

err

protected final PrintStream err

Constructor Detail

AbstractTextInterfaceDevice

public AbstractTextInterfaceDevice(InputStream inputStream,
                           PrintStream outputStream,
                           PrintStream errorStream)

Method Detail

exit

public void exit()

Terminates the currently running application normally (with a status code of zero). Equivalent to calling (and, if fact, calls) TextInterfaceDevice.exit(int) with an exitCode of 0.

Specified by:

exit in interface TextInterfaceDevice

printOut

public void printOut(char c)
              throws IOError

Prints a char to standard-out.

Specified by:

printOut in interface TextInterfaceDevice

Parameters:

c - The char to be printed

Throws:

IOError - if an I/O error occurs.

printOut

public void printOut(String s)
              throws IOError

Prints a String to standard-out.

Specified by:

printOut in interface TextInterfaceDevice

Parameters:

s - The String to be printed

Throws:

IOError - if an I/O error occurs.

printOut

public void printOut(Object o)
              throws IOError

Prints an Object to standard-out.

Specified by:

printOut in interface TextInterfaceDevice

Parameters:

o - The Object to be printed

Throws:

IOError - if an I/O error occurs.

printErr

public void printErr(char c)
              throws IOError

Prints a char to standard-err.

Specified by:

printErr in interface TextInterfaceDevice

Parameters:

c - The char to be printed

Throws:

IOError - if an I/O error occurs.

printErr

public void printErr(String s)
              throws IOError

Prints a String to standard-err.

Specified by:

printErr in interface TextInterfaceDevice

Parameters:

s - The String to be printed

Throws:

IOError - if an I/O error occurs.

printErr

public void printErr(Object o)
              throws IOError

Prints an Object to standard-out.

Specified by:

printErr in interface TextInterfaceDevice

Parameters:

o - The Object to be printed

Throws:

IOError - if an I/O error occurs.

printOutLn

public void printOutLn()
                throws IOError

Terminates the current standard-out line by writing the line separator string.

Specified by:

printOutLn in interface TextInterfaceDevice

Throws:

IOError - if an I/O error occurs.

printOutLn

public void printOutLn(char c)
                throws IOError

Prints a char to standard-out, then terminates the current line by writing the line separator string.

Specified by:

printOutLn in interface TextInterfaceDevice

Parameters:

c - The char to be printed

Throws:

IOError - if an I/O error occurs.

printOutLn

public void printOutLn(String s)
                throws IOError

Prints a String to standard-out, then terminates the current line by writing the line separator string.

Specified by:

printOutLn in interface TextInterfaceDevice

Parameters:

s - The String to be printed

Throws:

IOError - if an I/O error occurs.

outputMessage

public void outputMessage(String message)
                   throws IOError

Specified by:

outputMessage in interface OutputDevice

Throws:

IOError

printOutLn

public void printOutLn(Object o)
                throws IOError

Prints an Object to standard-out, then terminates the current line by writing the line separator string.

Specified by:

printOutLn in interface TextInterfaceDevice

Parameters:

o - The Object to be printed

Throws:

IOError - if an I/O error occurs.

printErrLn

public void printErrLn()
                throws IOError

Terminates the current standard-err line by writing the line separator string.

Specified by:

printErrLn in interface TextInterfaceDevice

Throws:

IOError - if an I/O error occurs.

printErrLn

public void printErrLn(char c)
                throws IOError

Prints a char to standard-err, then terminates the current line by writing the line separator string.

Specified by:

printErrLn in interface TextInterfaceDevice

Parameters:

c - The char to be printed

Throws:

IOError - if an I/O error occurs.

printErrLn

public void printErrLn(String s)
                throws IOError

Prints a String to standard-err, then terminates the current line by writing the line separator string.

Specified by:

printErrLn in interface TextInterfaceDevice

Parameters:

s - The String to be printed

Throws:

IOError - if an I/O error occurs.

outputErrorMessage

public void outputErrorMessage(String message)
                        throws IOError

Specified by:

outputErrorMessage in interface OutputDevice

Throws:

IOError

printErrLn

public void printErrLn(Object o)
                throws IOError

Prints an Object to standard-err, then terminates the current line by writing the line separator string.

Specified by:

printErrLn in interface TextInterfaceDevice

Parameters:

o - The Object to be printed

Throws:

IOError - if an I/O error occurs.

in

public InputStream in()

Gets the standard input stream.

Specified by:

in in interface TextInterfaceDevice

Returns:

the standard input stream.

out

public PrintStream out()

Gets the standard output stream.

Specified by:

out in interface TextInterfaceDevice

Returns:

the standard output stream.

err

public PrintStream err()

Gets the standard error stream.

Specified by:

err in interface TextInterfaceDevice

Returns:

the standard error stream.

promptForValidPassword

public char[] promptForValidPassword(int minLength,
                            int maxLength,
                            String what)
                              throws IOError

Prompts for a valid password by asking for the password using PasswordPrompter.readPassword(String, Object...), checking its length against the constraints, asking for the password to be confirmed, and checking to make sure the passwords match.

This method should continue to ask for the password over and over again until a valid password is entered and confirmed or the user cancels the operation.

Specified by:

promptForValidPassword in interface PasswordPrompter

Parameters:

minLength - The minimum legal length for the password

maxLength - The maximum legal length for the password

what - What we're prompting for a password for

Returns:

the valid, confirmed password entered by the user.

Throws:

IOError - if an I/O error occurs.