A B C D E F G I K L N P R S V W

A

addErrTag(String) - Method in class com.fedmest.cw.keyboard.internal.KeyboardUtilsDefImpl

addErrTag(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Adds the error tag to a string.

addPrompt(String) - Method in class com.fedmest.cw.keyboard.internal.KeyboardUtilsDefImpl

addPrompt(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Adds the input prompt to a string.

B

BooleanValidator - Class in com.fedmest.cw.keyboard.validators

This class is used internally by the KeyboardUtils.readBoolFromKeyboard() methods.

C

cancelValue() - Method in interface com.fedmest.cw.keyboard.KeyboardInputValidator

Allows you to specify the return value to offer when the user cancels input on a cancelable instance of KeyboardUtils .

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.BooleanValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.CharValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.DateValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.DoubleValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.FloatValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.IntValidator

cancelValue() - Method in class com.fedmest.cw.keyboard.validators.LongValidator

CharChoiceValidator - Class in com.fedmest.cw.keyboard.validators

This class checks for single-character input within a range of allowed characters.

CharChoiceValidator(char[]) - Constructor for class com.fedmest.cw.keyboard.validators.CharChoiceValidator

Creates a new instance of this validator with an array of characters to be allowed as input.

CharChoiceValidator(String) - Constructor for class com.fedmest.cw.keyboard.validators.CharChoiceValidator

Creates a new instance of this validator with a String containing the characters to be allowed as input.

CharValidator - Class in com.fedmest.cw.keyboard.validators

This class is used internally by the KeyboardUtils.readCharFromKeyboard() methods.

checkInput(String) - Method in interface com.fedmest.cw.keyboard.KeyboardInputValidator

Takes the input string, checks its validity and converts it to the data type specified by the type argument.

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.BooleanValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.CharValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.DateValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.DoubleValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.FloatValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.IntValidator

checkInput(String) - Method in class com.fedmest.cw.keyboard.validators.LongValidator

com.fedmest.cw.keyboard - package com.fedmest.cw.keyboard

This package defines the core of the Keyboard Library framework for accessing keyboard input.

com.fedmest.cw.keyboard.internal - package com.fedmest.cw.keyboard.internal

This package contains the default implementation of KeyboardUtils.

com.fedmest.cw.keyboard.validators - package com.fedmest.cw.keyboard.validators

This package provides basic implementations of KeyboardInputValidator.

D

DateValidator - Class in com.fedmest.cw.keyboard.validators

This class parses a string from user input.

DateValidator(String) - Constructor for class com.fedmest.cw.keyboard.validators.DateValidator

Creates a new instance of this validator with a string that represent the accepted format of the date that will be parsed following the conventions of the SimpleDateFormat class.

DateValidator(DateFormat) - Constructor for class com.fedmest.cw.keyboard.validators.DateValidator

Creates a new instance of this validator with a DateFormat instance detailing how the date should be parsed from the typed string.

DoubleValidator - Class in com.fedmest.cw.keyboard.validators

This class is used internally by the KeyboardUtils.readDoubleFromKeyboard() methods.

E

error(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Displays an error message to the user.

errorMessage - Static variable in class com.fedmest.cw.keyboard.validators.ValueTypeValidator

the error message that will be returned as the exception message if validation fails.

F

FloatValidator - Class in com.fedmest.cw.keyboard.validators

This class is used internally by the KeyboardUtils.readFloatFromKeyboard() methods.

G

getInstance() - Static method in class com.fedmest.cw.keyboard.validators.BooleanValidator

Returns the only available instance of this class

getInstance() - Static method in class com.fedmest.cw.keyboard.validators.CharValidator

Returns the only available instance of this class

getInstance() - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

Returns the only available instance of this class

getInstance() - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

Returns the only available instance of this class

getInstance() - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

Returns the only available instance of this class

getInstance() - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

Returns the only available instance of this class

I

IntValidator - Class in com.fedmest.cw.keyboard.validators

This class is used internally by the KeyboardUtils.readIntFromKeyboard(), KeyboardUtils.readHexFromKeyboard(), KeyboardUtils.readOctalFromKeyboard() and KeyboardUtils.readBinaryFromKeyboard() methods.

isCancelable() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Tells you whether the current instance of KeyboardUtils allows the user to cancel input.

isCaseSensitive() - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

Tells you whether this instance of the validator will take case into account when matching characters.

K

KeyboardInputException - Exception in com.fedmest.cw.keyboard

A keyboard validator (a class implementing KeyboardInputValidator) will throw this exception when the input string does not conform to the requirements of the expected data type.

KeyboardInputException() - Constructor for exception com.fedmest.cw.keyboard.KeyboardInputException

Creates a new instance of this exception with no message for the user and no cause.

KeyboardInputException(String, Throwable) - Constructor for exception com.fedmest.cw.keyboard.KeyboardInputException

Creates a new instance of this exception with a message for the user and a cause.

KeyboardInputException(String) - Constructor for exception com.fedmest.cw.keyboard.KeyboardInputException

Creates a new instance of this exception with a message for the user but no cause.

KeyboardInputException(Throwable) - Constructor for exception com.fedmest.cw.keyboard.KeyboardInputException

Creates a new instance of this exception with a cause but no message for the user.

KeyboardInputValidator<T> - Interface in com.fedmest.cw.keyboard

This interface should be implemented to create new ways of getting input from the keyboard.

KeyboardUtils - Class in com.fedmest.cw.keyboard

The KeyboardUtils class is an abstract class that defines the interface for easily accessing the keyboard.

KeyboardUtils() - Constructor for class com.fedmest.cw.keyboard.KeyboardUtils

KeyboardUtilsDefImpl - Class in com.fedmest.cw.keyboard.internal

This class is the default implementation of KeyboardUtils.

KeyboardUtilsDefImpl() - Constructor for class com.fedmest.cw.keyboard.internal.KeyboardUtilsDefImpl

L

LongValidator - Class in com.fedmest.cw.keyboard.validators

This class is used internally by the KeyboardUtils.readLongFromKeyboard() methods.

N

newDefaultKeyboard() - Static method in class com.fedmest.cw.keyboard.KeyboardUtils

Returns the default implementation of this abstract class.

P

prompt(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Displays an input prompt to the user.

R

readBinaryFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in binary notation without a prompt to the user.

readBinaryFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in binary notation.

readBoolFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a boolean response from the keyboard without a prompt to the user.

readBoolFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a boolean response from the keyboard.

readCharFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a character from the keyboard without a prompt to the user.

readCharFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a character from the keyboard.

readDoubleFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a double floating point value from the keyboard without a prompt to the user.

readDoubleFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a double floating point value from the keyboard.

readFloatFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a floating point value from the keyboard without a prompt to the user.

readFloatFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a floating point value from the keyboard.

readFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a new line of text from the keyboard and returns it as it was typed.

readFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Prints a prompt to the user on System.out, then reads a new line of text from the keyboard and returns it as it was typed.

readFromKeyboard(KeyboardInputValidator<T>) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a new line of text from the keyboard without printing out any prompt to the user and uses the specified KeyboardInputValidator to verify the input and convert it to the type offered by the validator itself.

readFromKeyboard(String, KeyboardInputValidator<T>) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Prints a prompt to the user on System.out, then reads a new line of text from the keyboard and uses the specified KeyboardInputValidator to verify the input and convert it to the type offered by the validator itself.

readHexFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in hexadecimal notation without a prompt to the user.

readHexFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in hexadecimal notation.

readIntFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard without a prompt to the user.

readIntFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard.

readIntFromKeyboard(String, int) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in the specified number base.

readLongFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a long value from the keyboard without a prompt to the user.

readLongFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads a long value from the keyboard.

readLongFromKeyboard(String, int) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an long value from the keyboard in the specified number base.

readOctalFromKeyboard() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in octal notation without a prompt to the user.

readOctalFromKeyboard(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Reads an int value from the keyboard in octal notation.

resetErrorMessage() - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method resets the error message that will be displayed to users on validation failure to the default text ("Invalid date - retry").

resetErrorMessage() - Static method in class com.fedmest.cw.keyboard.validators.ValueTypeValidator

This method resets the error message that will be displayed to users on validation failure to the default text ("Invalid value - retry").

resetErrorMessages() - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

This method resets the error messages that will be displayed to users on validation failure to the default text ("Invalid choice - retry").

resetMax() - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method resets the latest date that will be accepted by this validator to the latest possible date value.

resetMax() - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method resets the maximum double value that will be accepted by this validator to the highest possible double value.

resetMax() - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method resets the maximum float value that will be accepted by this validator to the highest possible float value.

resetMax() - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method resets the maximum integer value that will be accepted by this validator to the highest possible integer value.

resetMax() - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method resets the maximum long value that will be accepted by this validator to the highest possible long value.

resetMin() - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method resets the earliest date that will be accepted by this validator to the earliest possible date value.

resetMin() - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method resets the minimum double value that will be accepted by this validator to the lowest possible double value.

resetMin() - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method resets the minimum float value that will be accepted by this validator to the lowest possible float value.

resetMin() - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method resets the minimum integer value that will be accepted by this validator to the lowest possible integer value.

resetMin() - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method resets the minimum long value that will be accepted by this validator to the lowest possible long value.

resetRadix() - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method resets the number base to 10 (decimal numbers).

resetRadix() - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method resets the number base to 10 (decimal numbers).

resetRange() - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method resets the earliest and latest dates that will be accepted by this validator to the earliest and latest possible date values respectively.

resetRange() - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method resets the minimum and maximum double values that will be accepted by this validator to the lowest and highest possible double values respectively.

resetRange() - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method resets the minimum and maximum float values that will be accepted by this validator to the lowest and highest possible float values respectively.

resetRange() - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method resets the minimum and maximum integer values that will be accepted by this validator to the lowest and highest possible integer values respectively.

resetRange() - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method resets the minimum and maximum long values that will be accepted by this validator to the lowest and highest possible long values respectively.

resetRangeMessage() - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method resets to the default text the error message that will be displayed to users when the value is out of range ("Value out of range - retry").

resetRangeMessage() - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method resets to the default text the error message that will be displayed to users when the value is out of range ("Value out of range - retry").

resetRangeMessage() - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method resets to the default text the error message that will be displayed to users when the value is out of range ("Value out of range - retry").

resetRangeMessage() - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method resets to the default text the error message that will be displayed to users when the value is out of range ("Value out of range - retry").

resetRangeMessage() - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method resets to the default text the error message that will be displayed to users when the value is out of range ("Value out of range - retry").

S

setCancelable(boolean) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Specifies whether the current instance of KeyboardUtils allows the user to cancel input.

setCaseSensitive(boolean) - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

Specifies whether the validation of the characters should take case into consideration.

setErrorMessage(String) - Method in class com.fedmest.cw.keyboard.validators.DateValidator

Sets the error message that will be displayed to the user if validation fails because the input string was not a proper date value.

setErrorMessage(String) - Static method in class com.fedmest.cw.keyboard.validators.ValueTypeValidator

This method sets the error message that will be displayed to the user if validation fails.

setErrorMessages(String) - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

Sets the error messages that will be displayed to the user if validation fails either because the input string was longer than one character or because the input character is not among the allowed ones.

setErrorMessages(String, String) - Method in class com.fedmest.cw.keyboard.validators.CharChoiceValidator

Sets the error messages that will be displayed to the user if validation fails either because the input string was longer than one character or because the input character is not among the allowed ones.

setMax(Date) - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method sets the latest date that will be accepted by this validator.

setMax(double) - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method sets the maximum double value that will be accepted by this validator.

setMax(float) - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method sets the maximum float value that will be accepted by this validator.

setMax(int) - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method sets the maximum integer value that will be accepted by this validator.

setMax(long) - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method sets the maximum long value that will be accepted by this validator.

setMin(Date) - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method sets the earliest date that will be accepted by this validator.

setMin(double) - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method sets the minimum double value that will be accepted by this validator.

setMin(float) - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method sets the minimum float value that will be accepted by this validator.

setMin(int) - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method sets the minimum integer value that will be accepted by this validator.

setMin(long) - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method sets the minimum long value that will be accepted by this validator.

setRadix(int) - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method sets the number base that will be used the next time you pass this class to KeyboardUtils for validation.

setRadix(int) - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method sets the number base that will be used the next time you pass this class to KeyboardUtils for validation.

setRange(Date, Date) - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method sets the earliest and latest dates that will be accepted by this validator.

setRange(double, double) - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method sets the maximum and minimum double values that will be accepted by this validator.

setRange(float, float) - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method sets the maximum and minimum float values that will be accepted by this validator.

setRange(int, int) - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method sets the maximum and minimum integer values that will be accepted by this validator.

setRange(long, long) - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method sets the maximum and minimum long values that will be accepted by this validator.

setRangeMessage(String) - Method in class com.fedmest.cw.keyboard.validators.DateValidator

This method sets the error message that will be displayed to the user if validation fails due to a value being outside of the range specified with DateValidator.setMax(Date), DateValidator.setMin(Date) or DateValidator.setRange(Date, Date).

setRangeMessage(String) - Static method in class com.fedmest.cw.keyboard.validators.DoubleValidator

This method sets the error message that will be displayed to the user if validation fails due to a value being outside of the range specified with DoubleValidator.setMax(double), DoubleValidator.setMin(double) or DoubleValidator.setRange(double, double).

setRangeMessage(String) - Static method in class com.fedmest.cw.keyboard.validators.FloatValidator

This method sets the error message that will be displayed to the user if validation fails due to a value being outside of the range specified with FloatValidator.setMax(float), FloatValidator.setMin(float) or FloatValidator.setRange(float, float).

setRangeMessage(String) - Static method in class com.fedmest.cw.keyboard.validators.IntValidator

This method sets the error message that will be displayed to the user if validation fails due to a value being outside of the range specified with IntValidator.setMax(int), IntValidator.setMin(int) or IntValidator.setRange(int, int).

setRangeMessage(String) - Static method in class com.fedmest.cw.keyboard.validators.LongValidator

This method sets the error message that will be displayed to the user if validation fails due to a value being outside of the range specified with LongValidator.setMax(long), LongValidator.setMin(long) or LongValidator.setRange(long, long).

shouldCancel(String) - Method in class com.fedmest.cw.keyboard.internal.KeyboardUtilsDefImpl

shouldCancel(String) - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Checks whether a cancel sequence was typed.

V

ValueTypeValidator<T> - Class in com.fedmest.cw.keyboard.validators

Abstract base class for primitive data type input through the keyboard.

W

wasCanceled() - Method in class com.fedmest.cw.keyboard.KeyboardUtils

Tells you whether the user canceled input.

A B C D E F G I K L N P R S V W