Package org.fest.swing.keystroke

Class KeyStrokeMappingsParser

java.lang.Object

org.fest.swing.keystroke.KeyStrokeMappingsParser

public class KeyStrokeMappingsParser
extends Object

Understands creation of KeyStrokeMappings by parsing a text file.

Mappings for the following characters:

• Backspace
• Delete
• Enter
• Escape
• Tab

will be automatically added and should not be included to the file to parse.

The following is an example of a mapping file:

 a, A, NO_MASK
 A, A, SHIFT_MASK
 COMMA, COMMA, NO_MASK
 

Each line represents a character-keystroke mapping where each value is separated by a comma.

The first value represents the character to map. For example 'a' or 'A'. Since each field is separated by a comma, to map the ',' character we need to specify the text "COMMA."

The second value represents the key code, which should be the name of a key code from KeyEvent without the prefix "VK_". For example, if the key code is KeyEvent.VK_COMMA we just need to specify "COMMA".

The third value represents any modifiers to use, which should be the name of a modifier from InputEvent. For example, if the modifier to use is InputEvent.SHIFT_MASK we need to specify "SHIFT_MASK". If no modifiers are necessary, we just specify "NO_MASK".

Since:

1.2

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String,Character>	SPECIAL_MAPPINGS

Constructor Summary

Constructors

Constructor	Description
KeyStrokeMappingsParser()

Method Summary

Modifier and Type	Method	Description
private static char	characterFrom(String s)
private InputStream	fileAsStream(File file)
private InputStream	fileAsStream(String file)
private static int	keyCodeFrom(String s)
private static String	keyCodeNameFrom(String s)
(package private) KeyStrokeMapping	mappingFrom(String line)
private static int	modifiersFrom(String s)
private static ParsingException	notConformingWithPatternError(String line)
KeyStrokeMappingProvider	parse(File file)	Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the given file.
private KeyStrokeMappingProvider	parse(InputStream input)
KeyStrokeMappingProvider	parse(String file)	Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the file with the given name.
private static String[]	split(String line)
private void	validate(File file)
private void	validate(String file)

Methods inherited from class java.lang.Object

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

Field Details

SPECIAL_MAPPINGS

private static final Map<String,Character> SPECIAL_MAPPINGS

Constructor Details

KeyStrokeMappingsParser

public KeyStrokeMappingsParser()

Method Details

parse

public KeyStrokeMappingProvider parse(String file)

Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the file with the given name.

Note: This attempts to read the file using ClassLoader.getResourceAsStream(String).

Parameters:

file - the name of the file to parse.

Returns:

the created KeyStrokeMappingProvider.

Throws:

NullPointerException - if the given name is null.

IllegalArgumentException - if the given name is empty.

ParsingException - if any error occurs during parsing.

See Also:

• parse(File)

validate

private void validate(String file)

fileAsStream

private InputStream fileAsStream(String file)

parse

public KeyStrokeMappingProvider parse(File file)

Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the given file.

Parameters:

file - the file to parse.

Returns:

the created KeyStrokeMappingProvider.

Throws:

NullPointerException - if the given file is null.

IllegalArgumentException - if the given file does not represent an existing file.

ParsingException - if any error occurs during parsing.

validate

private void validate(File file)

fileAsStream

private InputStream fileAsStream(File file)

parse

private KeyStrokeMappingProvider parse(InputStream input)
                                throws IOException

Throws:

IOException

mappingFrom

KeyStrokeMapping mappingFrom(String line)

split

private static String[] split(String line)

notConformingWithPatternError

private static ParsingException notConformingWithPatternError(String line)

characterFrom

private static char characterFrom(String s)

keyCodeFrom

private static int keyCodeFrom(String s)

keyCodeNameFrom

private static String keyCodeNameFrom(String s)

modifiersFrom

private static int modifiersFrom(String s)