View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.i18n;
35  
36  import java.util.Locale;
37  
38  import org.apache.commons.lang3.StringUtils;
39  
40  
41  /**
42   * General language definition. Used to configure the i18n components.
43   */
44  public class LocaleDefinition {
45  
46      public static LocaleDefinition make(String language, String country, boolean enabled) {
47          return new LocaleDefinition(language, country, enabled);
48      }
49  
50      private String country;
51  
52      private String language;
53  
54      private boolean enabled;
55  
56      private Locale locale;
57  
58      public LocaleDefinition() {
59      }
60  
61      // worked around by making the ctor protected and adding a public static factory method. discuss.
62      protected LocaleDefinition(String language, String country, boolean enabled) {
63          this.language = language;
64          this.country = country;
65          this.enabled = enabled;
66      }
67  
68      /**
69       * Creates the locale for this definition if not yet set.
70       */
71      public Locale getLocale() {
72          if (locale == null && getLanguage() != null) {
73              locale = new Locale(getLanguage(), StringUtils.defaultString(getCountry()));
74          }
75          return locale;
76      }
77  
78      public String getCountry() {
79          return this.country;
80      }
81  
82      public void setCountry(String country) {
83          this.country = country;
84      }
85  
86      public boolean isEnabled() {
87          return this.enabled;
88      }
89  
90      public void setEnabled(boolean enabled) {
91          this.enabled = enabled;
92      }
93  
94      public String getLanguage() {
95          return this.language;
96      }
97  
98      public void setLanguage(String language) {
99          this.language = language;
100     }
101 
102     public void setLocale(Locale locale) {
103         this.locale = locale;
104     }
105 
106     /**
107      * Uses the locals toString() method.
108      */
109     @Override
110     public String toString() {
111         return getLocale() != null ? getLocale().toString() : "none";
112     }
113 
114     public String getId() {
115         return getLocale().toString();
116     }
117 }