blob: bc5c9ea720218b2132ded3ad4047c5e72ad8ab7c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.dialer.smartdial;
import android.support.v4.util.SimpleArrayMap;
import com.google.common.base.Optional;
/** Definition for utilities that supports smart dial in different languages. */
@SuppressWarnings("Guava")
abstract class SmartDialMap {
/**
* Returns true if the provided character can be mapped to a key on the dialpad.
*
* <p>The provided character is expected to be a normalized character. See {@link
* SmartDialMap#normalizeCharacter(char)} for details.
*/
protected boolean isValidDialpadCharacter(char ch) {
return isValidDialpadAlphabeticChar(ch) || isValidDialpadNumericChar(ch);
}
/**
* Returns true if the provided character is a letter and can be mapped to a key on the dialpad.
*
* <p>The provided character is expected to be a normalized character. See {@link
* SmartDialMap#normalizeCharacter(char)} for details.
*/
protected boolean isValidDialpadAlphabeticChar(char ch) {
return getCharToKeyMap().containsKey(ch);
}
/**
* Returns true if the provided character is a digit, and can be mapped to a key on the dialpad.
*/
protected boolean isValidDialpadNumericChar(char ch) {
return '0' <= ch && ch <= '9';
}
/**
* Get the index of the key on the dialpad which the character corresponds to.
*
* <p>The provided character is expected to be a normalized character. See {@link
* SmartDialMap#normalizeCharacter(char)} for details.
*
* <p>An {@link Optional#absent()} is returned if the provided character can't be mapped to a key
* on the dialpad.
*/
protected Optional<Byte> getDialpadIndex(char ch) {
if (isValidDialpadNumericChar(ch)) {
return Optional.of((byte) (ch - '0'));
}
if (isValidDialpadAlphabeticChar(ch)) {
return Optional.of((byte) (getCharToKeyMap().get(ch) - '0'));
}
return Optional.absent();
}
/**
* Get the actual numeric character on the dialpad which the character corresponds to.
*
* <p>The provided character is expected to be a normalized character. See {@link
* SmartDialMap#normalizeCharacter(char)} for details.
*
* <p>An {@link Optional#absent()} is returned if the provided character can't be mapped to a key
* on the dialpad.
*/
protected Optional<Character> getDialpadNumericCharacter(char ch) {
return isValidDialpadAlphabeticChar(ch)
? Optional.of(getCharToKeyMap().get(ch))
: Optional.absent();
}
/**
* Converts uppercase characters to lower case ones, and on a best effort basis, strips accents
* from accented characters.
*
* <p>An {@link Optional#absent()} is returned if the provided character can't be mapped to a key
* on the dialpad.
*/
abstract Optional<Character> normalizeCharacter(char ch);
/**
* Returns a map in which each key is a normalized character and the corresponding value is a
* dialpad key.
*/
abstract SimpleArrayMap<Character, Character> getCharToKeyMap();
}
|
