aboutsummaryrefslogtreecommitdiff
path: root/java/src/com/android/i18n/addressinput/RegionData.java
blob: 62d3821dfd44d2693e61d4a03e7b585589ca16be (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
104
105
106
107
/*
 * Copyright (C) 2010 Google Inc.
 *
 * 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.i18n.addressinput;

/**
 * A simple class to hold region data. Instances of this class are immutable.
 */
class RegionData {

  private String key;
  private String name;

  /**
   * Create a new RegionData object.
   */
  private RegionData() {
  }

  /**
   * Copy constructor. data should not be null.
   *
   * @param data A populated instance of RegionData
   */
  private RegionData(RegionData data) {
    Util.checkNotNull(data);
    key = data.key;
    name = data.name;
  }

  /**
   * Gets the key of the region. For example, California's key is "CA".
   */
  String getKey() {
    return key;
  }

  /**
   * Gets the name. Returns null if not specified.
   */
  String getName() {
    return name;
  }

  /**
   * Gets the best display name. Returns the name if this is not null, otherwise the key.
   */
  public String getDisplayName() {
    return (name != null) ? name : key;
  }

  /**
   * Checks if the input subkey is the name (in Latin or local script) of the region. Returns
   * false if subkey is not a valid name for the region, or the input subkey is null.
   *
   * @param subkey a string that refers to the name of a geo location. Like "California", "CA", or
   *               "Mountain View". Names in the local script are also supported.
   */
  boolean isValidName(String subkey) {
    if (subkey == null) {
      return false;
    }
    if (subkey.equalsIgnoreCase(key) || subkey.equalsIgnoreCase(name)) {
      return true;
    }
    return false;
  }

  /**
   * A builder class to facilitate the creation of RegionData objects.
   */
  static class Builder {
    RegionData data = new RegionData();

    RegionData build() {
      return new RegionData(data);
    }

    Builder setKey(String key) {
      Util.checkNotNull(key, "Key should not be null.");
      data.key = key;
      return this;
    }

    /**
     * Sets name of the region. For example, "California". If the name is an empty string, sets
     * it to null.
     */
    Builder setName(String name) {
      data.name = Util.trimToNull(name);
      return this;
    }
  }
}