com.hypirion.io

Class ConsoleUtils

java.lang.Object

com.hypirion.io.ConsoleUtils

public final class ConsoleUtils
extends java.lang.Object

The ConsoleUtils class is a static collection of methods used to modify or use the console in rather unconventional ways. It is mainly a way to set on and off echoing in the console, either manually or through password reading from an arbitrary InputStream.

Since:

com.hypirion.io 0.3.0

See Also:

Console

Constructor Summary

Constructors

Constructor and Description
ConsoleUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static char[]	readPassword(java.io.InputStream is) A static method which will read from a given InputStream while it turns echo off in the JVM console.
static boolean	setEcho(boolean on) A static method which peeks into the Console class and manually turns on or off echoing in the given console.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleUtils

public ConsoleUtils()

Method Detail

setEcho

public static boolean setEcho(boolean on)
                       throws java.lang.NoSuchMethodException,
                              java.lang.IllegalAccessException,
                              java.lang.NoSuchFieldException,
                              java.lang.reflect.InvocationTargetException

A static method which peeks into the Console class and manually turns on or off echoing in the given console.

Parameters:

on - whether to set echoing on or off.

Throws:

java.lang.NoSuchMethodException - if Java's own console class have no private method named "echo".

java.lang.NoSuchFieldException - if Java's own console class have no private field named "echoOff".

java.lang.reflect.InvocationTargetException - if Java's own console class have a private method named "echo", but that this method tries to invoke that method erroneously.

java.lang.IllegalAccessException - if the access restrictions prohibits this method from modifying and using private methods in Java's own console class.

readPassword

public static char[] readPassword(java.io.InputStream is)
                           throws java.lang.NoSuchMethodException,
                                  java.lang.IllegalAccessException,
                                  java.lang.NoSuchFieldException,
                                  java.lang.reflect.InvocationTargetException,
                                  java.io.IOException

A static method which will read from a given InputStream while it turns echo off in the JVM console. Works just as Console.readPassword(java.lang.String, java.lang.Object...).

Parameters:

is - the InputStream to read from.

Throws:

java.lang.NoSuchMethodException - if Java's own console class have no private method named "echo".

java.lang.NoSuchFieldException - if Java's own console class have no private field named "echoOff".

java.lang.reflect.InvocationTargetException - if Java's own console class have a private method named "echo", but that this method tries to invoke that method erroneously.

java.lang.IllegalAccessException - if the access restrictions prohibits setEcho(boolean) from modifying and using private methods in Java's own console class.

java.io.IOException - if the given InputStream throws an IOException.