Merge branch 'master' of elynx.fr:repo/jvcard
[jvcard.git] / src / com / googlecode / lanterna / input / KeyDecodingProfile.java
1 /*
2 * This file is part of lanterna (http://code.google.com/p/lanterna/).
3 *
4 * lanterna is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 *
17 * Copyright (C) 2010-2015 Martin
18 */
19 package com.googlecode.lanterna.input;
20
21 import java.util.Collection;
22
23 /**
24 * In order to convert a stream of characters into objects representing keystrokes, we need to apply logic on this
25 * stream to detect special characters. In lanterna, this is done by using a set of character patterns which are matched
26 * against the stream until we've found the best match. This interface represents a set of such patterns, a 'profile'
27 * with is used when decoding the input. There is a default profile, DefaultKeyDecodingProfile, which will probably
28 * do what you need but you can also extend and define your own patterns.
29 *
30 * @author Martin
31 */
32 public interface KeyDecodingProfile {
33 /**
34 * Static constant for the ESC key
35 */
36 char ESC_CODE = (char) 0x1b;
37
38 /**
39 * Returns a collection of character patterns that makes up this profile
40 * @return Collection of patterns in this profile
41 */
42 Collection<CharacterPattern> getPatterns();
43 }