edu.wpi.first.wpilibj

Class Preferences.ImproperPreferenceKeyException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

edu.wpi.first.wpilibj.Preferences.ImproperPreferenceKeyException

All Implemented Interfaces:

Serializable

Enclosing class:

Preferences

public static class Preferences.ImproperPreferenceKeyException
extends RuntimeException

Should be thrown if a string can not be used as a key in the preferences file. This happens if the string contains a new line, a space, a tab, or an equals sign.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImproperPreferenceKeyException(String value, char letter) Instantiates an exception with a descriptive message based on the input.

Method Summary

Modifier and Type	Method and Description
static void	confirmString(String value) Tests if the given string is ok to use as a key in the preference table.
static boolean	isAcceptable(String value) Returns whether or not the given string is ok to use in the preference table.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ImproperPreferenceKeyException

public ImproperPreferenceKeyException(String value,
                                      char letter)

Instantiates an exception with a descriptive message based on the input.

Parameters:

value - the illegal key

letter - the specific character that made it illegal

Method Detail

confirmString

public static void confirmString(String value)

Tests if the given string is ok to use as a key in the preference table. If not, then a Preferences.ImproperPreferenceKeyException will be thrown.

Parameters:

value - the value to test

isAcceptable

public static boolean isAcceptable(String value)

Returns whether or not the given string is ok to use in the preference table.

Parameters:

value - the string to check

Returns:

true if the given string is ok to use in the preference table