diff --git a/Java/commons-lang-LocaleUtils_193/Dockerfile b/Java/commons-lang-LocaleUtils_193/Dockerfile new file mode 100644 index 000000000..7b7fbe349 --- /dev/null +++ b/Java/commons-lang-LocaleUtils_193/Dockerfile @@ -0,0 +1,18 @@ +FROM ghcr.io/kupl/starlab-benchmarks/java-base:commons-lang + +ENV TZ=Asia/Seoul + +COPY ./metadata.json . +COPY ./npe.json . +COPY ./buggy.java /tmp/buggy.java +RUN export BUGGY_PATH=$(cat metadata.json | jq -r ".npe.filepath") \ + && export BUGGY_LINE=$(cat metadata.json | jq -r ".npe.line") \ + && export BUGGY_MTHD=$(cat metadata.json | jq -r ".npe.npe_method") \ + && mv /tmp/buggy.java $BUGGY_PATH \ + && echo "[{\"filepath\": \"$BUGGY_PATH\", \"line\": $BUGGY_LINE, \"method_name\": \"$BUGGY_MTHD\"}]" | jq . > traces.json + +RUN git init . && git add -A + +RUN $(cat metadata.json | jq -r ".buildCommand") + +RUN $(cat metadata.json | jq -r ".testCommand"); if [ $? -eq 0 ]; then exit 1; fi diff --git a/Java/commons-lang-LocaleUtils_193/buggy.java b/Java/commons-lang-LocaleUtils_193/buggy.java new file mode 100644 index 000000000..4bf86865d --- /dev/null +++ b/Java/commons-lang-LocaleUtils_193/buggy.java @@ -0,0 +1,348 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.commons.lang3; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; + +/** + *
Operations to assist when working with a {@link Locale}.
+ * + *This class tries to handle {@code null} input gracefully. + * An exception will not be thrown for a {@code null} input. + * Each method documents its behaviour in more detail.
+ * + * @since 2.2 + */ +public class LocaleUtils { + + /** Concurrent map of language locales by country. */ + private static final ConcurrentMap{@code LocaleUtils} instances should NOT be constructed in standard programming. + * Instead, the class should be used as {@code LocaleUtils.toLocale("en_GB");}.
+ * + *This constructor is public to permit tools that require a JavaBean instance + * to operate.
+ */ + public LocaleUtils() { + super(); + } + + //----------------------------------------------------------------------- + /** + *Converts a String to a Locale.
+ * + *This method takes the string format of a locale and creates the + * locale object from it.
+ * + *+ * LocaleUtils.toLocale("") = new Locale("", "") + * LocaleUtils.toLocale("en") = new Locale("en", "") + * LocaleUtils.toLocale("en_GB") = new Locale("en", "GB") + * LocaleUtils.toLocale("en_GB_xxx") = new Locale("en", "GB", "xxx") (#) + *+ * + *
(#) The behaviour of the JDK variant constructor changed between JDK1.3 and JDK1.4. + * In JDK1.3, the constructor upper cases the variant, in JDK1.4, it doesn't. + * Thus, the result from getVariant() may vary depending on your JDK.
+ * + *This method validates the input strictly. + * The language code must be lowercase. + * The country code must be uppercase. + * The separator must be an underscore. + * The length must be correct. + *
+ * + * @param str the locale String to convert, null returns null + * @return a Locale, null if null input + * @throws IllegalArgumentException if the string is an invalid format + * @see Locale#forLanguageTag(String) + */ + public static Locale toLocale(final String str) { + if (str == null) { + return null; + } + if (str.isEmpty()) { // LANG-941 - JDK 8 introduced an empty locale where all fields are blank + return new Locale(StringUtils.EMPTY, StringUtils.EMPTY); + } + if (str.contains("#")) { // LANG-879 - Cannot handle Java 7 script & extensions + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final int len = str.length(); + if (len < 2) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final char ch0 = str.charAt(0); + if (ch0 == '_') { + if (len < 3) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final char ch1 = str.charAt(1); + final char ch2 = str.charAt(2); + if (!Character.isUpperCase(ch1) || !Character.isUpperCase(ch2)) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + if (len == 3) { + return new Locale(StringUtils.EMPTY, str.substring(1, 3)); + } + if (len < 5) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + if (str.charAt(3) != '_') { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + return new Locale(StringUtils.EMPTY, str.substring(1, 3), str.substring(4)); + } + + final String[] split = str.split("_", -1); + final int occurrences = split.length -1; + switch (occurrences) { + case 0: + if (StringUtils.isAllLowerCase(str) && (len == 2 || len == 3)) { + return new Locale(str); + } + throw new IllegalArgumentException("Invalid locale format: " + str); + + case 1: + if (StringUtils.isAllLowerCase(split[0]) && + (split[0].length() == 2 || split[0].length() == 3) && + split[1].length() == 2 && StringUtils.isAllUpperCase(split[1])) { + return new Locale(split[0], split[1]); + } + throw new IllegalArgumentException("Invalid locale format: " + str); + + case 2: + if (StringUtils.isAllLowerCase(split[0]) && + (split[0].length() == 2 || split[0].length() == 3) && + (split[1].length() == 0 || split[1].length() == 2 && StringUtils.isAllUpperCase(split[1])) && + split[2].length() > 0) { + return new Locale(split[0], split[1], split[2]); + } + + //$FALL-THROUGH$ + default: + throw new IllegalArgumentException("Invalid locale format: " + str); + } + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr","CA","xxx")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr")] + *+ * + * @param locale the locale to start from + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static List
Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr", "CA", "xxx"), Locale("en")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr"), Locale("en"] + *+ * + *
The result list begins with the most specific locale, then the + * next more general and so on, finishing with the default locale. + * The list will never contain the same locale twice.
+ * + * @param locale the locale to start from, null returns empty list + * @param defaultLocale the default locale to use if no other is found + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ +// ----------------------------------------------------------------------- +/** + *Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr", "CA", "xxx"), Locale("en")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr"), Locale("en"] + *+ * + *
The result list begins with the most specific locale, then the + * next more general and so on, finishing with the default locale. + * The list will never contain the same locale twice.
+ * + * @param locale + * the locale to start from, null returns empty list + * @param defaultLocale + * the default locale to use if no other is found + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ +public static java.util.ListObtains an unmodifiable list of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable list of available locales + */ + public static ListObtains an unmodifiable set of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable set of available locales + */ + public static SetChecks if the locale specified is in the list of available locales.
+ * + * @param locale the Locale object to check if it is available + * @return true if the locale is a known locale + */ + public static boolean isAvailableLocale(final Locale locale) { + return availableLocaleList().contains(locale); + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of languages supported for a given country.
+ * + *This method takes a country code and searches to find the + * languages available for that country. Variant locales are removed.
+ * + * @param countryCode the 2 letter country code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ + public static ListObtains the list of countries supported for a given language.
+ * + *This method takes a language code and searches to find the + * countries available for that language. Variant locales are removed.
+ * + * @param languageCode the 2 letter language code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ + public static ListOperations to assist when working with a {@link Locale}.
+ * + *This class tries to handle {@code null} input gracefully. + * An exception will not be thrown for a {@code null} input. + * Each method documents its behaviour in more detail.
+ * + * @since 2.2 + */ +public class LocaleUtils { + + /** Concurrent map of language locales by country. */ + private static final ConcurrentMap{@code LocaleUtils} instances should NOT be constructed in standard programming. + * Instead, the class should be used as {@code LocaleUtils.toLocale("en_GB");}.
+ * + *This constructor is public to permit tools that require a JavaBean instance + * to operate.
+ */ + public LocaleUtils() { + super(); + } + + //----------------------------------------------------------------------- + /** + *Converts a String to a Locale.
+ * + *This method takes the string format of a locale and creates the + * locale object from it.
+ * + *+ * LocaleUtils.toLocale("") = new Locale("", "") + * LocaleUtils.toLocale("en") = new Locale("en", "") + * LocaleUtils.toLocale("en_GB") = new Locale("en", "GB") + * LocaleUtils.toLocale("en_GB_xxx") = new Locale("en", "GB", "xxx") (#) + *+ * + *
(#) The behaviour of the JDK variant constructor changed between JDK1.3 and JDK1.4. + * In JDK1.3, the constructor upper cases the variant, in JDK1.4, it doesn't. + * Thus, the result from getVariant() may vary depending on your JDK.
+ * + *This method validates the input strictly. + * The language code must be lowercase. + * The country code must be uppercase. + * The separator must be an underscore. + * The length must be correct. + *
+ * + * @param str the locale String to convert, null returns null + * @return a Locale, null if null input + * @throws IllegalArgumentException if the string is an invalid format + * @see Locale#forLanguageTag(String) + */ + public static Locale toLocale(final String str) { + if (str == null) { + return null; + } + if (str.isEmpty()) { // LANG-941 - JDK 8 introduced an empty locale where all fields are blank + return new Locale(StringUtils.EMPTY, StringUtils.EMPTY); + } + if (str.contains("#")) { // LANG-879 - Cannot handle Java 7 script & extensions + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final int len = str.length(); + if (len < 2) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final char ch0 = str.charAt(0); + if (ch0 == '_') { + if (len < 3) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final char ch1 = str.charAt(1); + final char ch2 = str.charAt(2); + if (!Character.isUpperCase(ch1) || !Character.isUpperCase(ch2)) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + if (len == 3) { + return new Locale(StringUtils.EMPTY, str.substring(1, 3)); + } + if (len < 5) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + if (str.charAt(3) != '_') { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + return new Locale(StringUtils.EMPTY, str.substring(1, 3), str.substring(4)); + } + + final String[] split = str.split("_", -1); + final int occurrences = split.length -1; + switch (occurrences) { + case 0: + if (StringUtils.isAllLowerCase(str) && (len == 2 || len == 3)) { + return new Locale(str); + } + throw new IllegalArgumentException("Invalid locale format: " + str); + + case 1: + if (StringUtils.isAllLowerCase(split[0]) && + (split[0].length() == 2 || split[0].length() == 3) && + split[1].length() == 2 && StringUtils.isAllUpperCase(split[1])) { + return new Locale(split[0], split[1]); + } + throw new IllegalArgumentException("Invalid locale format: " + str); + + case 2: + if (StringUtils.isAllLowerCase(split[0]) && + (split[0].length() == 2 || split[0].length() == 3) && + (split[1].length() == 0 || split[1].length() == 2 && StringUtils.isAllUpperCase(split[1])) && + split[2].length() > 0) { + return new Locale(split[0], split[1], split[2]); + } + + //$FALL-THROUGH$ + default: + throw new IllegalArgumentException("Invalid locale format: " + str); + } + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr","CA","xxx")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr")] + *+ * + * @param locale the locale to start from + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static List
Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr", "CA", "xxx"), Locale("en")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr"), Locale("en"] + *+ * + *
The result list begins with the most specific locale, then the + * next more general and so on, finishing with the default locale. + * The list will never contain the same locale twice.
+ * + * @param locale the locale to start from, null returns empty list + * @param defaultLocale the default locale to use if no other is found + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static ListObtains an unmodifiable list of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable list of available locales + */ + public static ListObtains an unmodifiable set of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable set of available locales + */ + public static SetChecks if the locale specified is in the list of available locales.
+ * + * @param locale the Locale object to check if it is available + * @return true if the locale is a known locale + */ + public static boolean isAvailableLocale(final Locale locale) { + return availableLocaleList().contains(locale); + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of languages supported for a given country.
+ * + *This method takes a country code and searches to find the + * languages available for that country. Variant locales are removed.
+ * + * @param countryCode the 2 letter country code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ +// ----------------------------------------------------------------------- +/** + *Obtains the list of languages supported for a given country.
+ * + *This method takes a country code and searches to find the + * languages available for that country. Variant locales are removed.
+ * + * @param countryCode + * the 2 letter country code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ +public static java.util.ListObtains the list of countries supported for a given language.
+ * + *This method takes a language code and searches to find the + * countries available for that language. Variant locales are removed.
+ * + * @param languageCode the 2 letter language code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ + public static ListOperations to assist when working with a {@link Locale}.
+ * + *This class tries to handle {@code null} input gracefully. + * An exception will not be thrown for a {@code null} input. + * Each method documents its behaviour in more detail.
+ * + * @since 2.2 + */ +public class LocaleUtils { + + /** Concurrent map of language locales by country. */ + private static final ConcurrentMap{@code LocaleUtils} instances should NOT be constructed in standard programming. + * Instead, the class should be used as {@code LocaleUtils.toLocale("en_GB");}.
+ * + *This constructor is public to permit tools that require a JavaBean instance + * to operate.
+ */ + public LocaleUtils() { + super(); + } + + //----------------------------------------------------------------------- + /** + *Converts a String to a Locale.
+ * + *This method takes the string format of a locale and creates the + * locale object from it.
+ * + *+ * LocaleUtils.toLocale("") = new Locale("", "") + * LocaleUtils.toLocale("en") = new Locale("en", "") + * LocaleUtils.toLocale("en_GB") = new Locale("en", "GB") + * LocaleUtils.toLocale("en_GB_xxx") = new Locale("en", "GB", "xxx") (#) + *+ * + *
(#) The behaviour of the JDK variant constructor changed between JDK1.3 and JDK1.4. + * In JDK1.3, the constructor upper cases the variant, in JDK1.4, it doesn't. + * Thus, the result from getVariant() may vary depending on your JDK.
+ * + *This method validates the input strictly. + * The language code must be lowercase. + * The country code must be uppercase. + * The separator must be an underscore. + * The length must be correct. + *
+ * + * @param str the locale String to convert, null returns null + * @return a Locale, null if null input + * @throws IllegalArgumentException if the string is an invalid format + * @see Locale#forLanguageTag(String) + */ + public static Locale toLocale(final String str) { + if (str == null) { + return null; + } + if (str.isEmpty()) { // LANG-941 - JDK 8 introduced an empty locale where all fields are blank + return new Locale(StringUtils.EMPTY, StringUtils.EMPTY); + } + if (str.contains("#")) { // LANG-879 - Cannot handle Java 7 script & extensions + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final int len = str.length(); + if (len < 2) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final char ch0 = str.charAt(0); + if (ch0 == '_') { + if (len < 3) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + final char ch1 = str.charAt(1); + final char ch2 = str.charAt(2); + if (!Character.isUpperCase(ch1) || !Character.isUpperCase(ch2)) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + if (len == 3) { + return new Locale(StringUtils.EMPTY, str.substring(1, 3)); + } + if (len < 5) { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + if (str.charAt(3) != '_') { + throw new IllegalArgumentException("Invalid locale format: " + str); + } + return new Locale(StringUtils.EMPTY, str.substring(1, 3), str.substring(4)); + } + + final String[] split = str.split("_", -1); + final int occurrences = split.length -1; + switch (occurrences) { + case 0: + if (StringUtils.isAllLowerCase(str) && (len == 2 || len == 3)) { + return new Locale(str); + } + throw new IllegalArgumentException("Invalid locale format: " + str); + + case 1: + if (StringUtils.isAllLowerCase(split[0]) && + (split[0].length() == 2 || split[0].length() == 3) && + split[1].length() == 2 && StringUtils.isAllUpperCase(split[1])) { + return new Locale(split[0], split[1]); + } + throw new IllegalArgumentException("Invalid locale format: " + str); + + case 2: + if (StringUtils.isAllLowerCase(split[0]) && + (split[0].length() == 2 || split[0].length() == 3) && + (split[1].length() == 0 || split[1].length() == 2 && StringUtils.isAllUpperCase(split[1])) && + split[2].length() > 0) { + return new Locale(split[0], split[1], split[2]); + } + + //$FALL-THROUGH$ + default: + throw new IllegalArgumentException("Invalid locale format: " + str); + } + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr","CA","xxx")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr")] + *+ * + * @param locale the locale to start from + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static List
Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr", "CA", "xxx"), Locale("en")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr"), Locale("en"] + *+ * + *
The result list begins with the most specific locale, then the + * next more general and so on, finishing with the default locale. + * The list will never contain the same locale twice.
+ * + * @param locale the locale to start from, null returns empty list + * @param defaultLocale the default locale to use if no other is found + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static ListObtains an unmodifiable list of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable list of available locales + */ + public static ListObtains an unmodifiable set of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable set of available locales + */ + public static SetChecks if the locale specified is in the list of available locales.
+ * + * @param locale the Locale object to check if it is available + * @return true if the locale is a known locale + */ + public static boolean isAvailableLocale(final Locale locale) { + return availableLocaleList().contains(locale); + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of languages supported for a given country.
+ * + *This method takes a country code and searches to find the + * languages available for that country. Variant locales are removed.
+ * + * @param countryCode the 2 letter country code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ + public static ListObtains the list of countries supported for a given language.
+ * + *This method takes a language code and searches to find the + * countries available for that language. Variant locales are removed.
+ * + * @param languageCode the 2 letter language code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ +// ----------------------------------------------------------------------- +/** + *Obtains the list of countries supported for a given language.
+ * + *This method takes a language code and searches to find the + * countries available for that language. Variant locales are removed.
+ * + * @param languageCode + * the 2 letter language code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ +public static java.util.ListOperations to assist when working with a {@link Locale}.
+ * + *This class tries to handle {@code null} input gracefully. + * An exception will not be thrown for a {@code null} input. + * Each method documents its behaviour in more detail.
+ * + * @since 2.2 + */ +public class LocaleUtils { + + /** Concurrent map of language locales by country. */ + private static final ConcurrentMap{@code LocaleUtils} instances should NOT be constructed in standard programming. + * Instead, the class should be used as {@code LocaleUtils.toLocale("en_GB");}.
+ * + *This constructor is public to permit tools that require a JavaBean instance + * to operate.
+ */ + public LocaleUtils() { + super(); + } + + //----------------------------------------------------------------------- + /** + *Converts a String to a Locale.
+ * + *This method takes the string format of a locale and creates the + * locale object from it.
+ * + *+ * LocaleUtils.toLocale("") = new Locale("", "") + * LocaleUtils.toLocale("en") = new Locale("en", "") + * LocaleUtils.toLocale("en_GB") = new Locale("en", "GB") + * LocaleUtils.toLocale("en_GB_xxx") = new Locale("en", "GB", "xxx") (#) + *+ * + *
(#) The behaviour of the JDK variant constructor changed between JDK1.3 and JDK1.4. + * In JDK1.3, the constructor upper cases the variant, in JDK1.4, it doesn't. + * Thus, the result from getVariant() may vary depending on your JDK.
+ * + *This method validates the input strictly. + * The language code must be lowercase. + * The country code must be uppercase. + * The separator must be an underscore. + * The length must be correct. + *
+ * + * @param str the locale String to convert, null returns null + * @return a Locale, null if null input + * @throws IllegalArgumentException if the string is an invalid format + * @see Locale#forLanguageTag(String) + */ +// ----------------------------------------------------------------------- +/** + *Converts a String to a Locale.
+ * + *This method takes the string format of a locale and creates the + * locale object from it.
+ * + *+ * LocaleUtils.toLocale("") = new Locale("", "") + * LocaleUtils.toLocale("en") = new Locale("en", "") + * LocaleUtils.toLocale("en_GB") = new Locale("en", "GB") + * LocaleUtils.toLocale("en_GB_xxx") = new Locale("en", "GB", "xxx") (#) + *+ * + *
(#) The behaviour of the JDK variant constructor changed between JDK1.3 and JDK1.4. + * In JDK1.3, the constructor upper cases the variant, in JDK1.4, it doesn't. + * Thus, the result from getVariant() may vary depending on your JDK.
+ * + *This method validates the input strictly. + * The language code must be lowercase. + * The country code must be uppercase. + * The separator must be an underscore. + * The length must be correct. + *
+ * + * @param str + * the locale String to convert, null returns null + * @return a Locale, null if null input + * @throws IllegalArgumentException + * if the string is an invalid format + * @see Locale#forLanguageTag(String) + */ +public static java.util.Locale toLocale(final java.lang.String str) { + { + if (/* NPEX_NULL_EXP */ + str.isEmpty()) { + // LANG-941 - JDK 8 introduced an empty locale where all fields are blank + return new java.util.Locale(org.apache.commons.lang3.StringUtils.EMPTY, org.apache.commons.lang3.StringUtils.EMPTY); + } + if (str.contains("#")) { + // LANG-879 - Cannot handle Java 7 script & extensions + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + final int len = str.length(); + if (len < 2) { + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + final char ch0 = str.charAt(0); + if (ch0 == '_') { + if (len < 3) { + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + final char ch1 = str.charAt(1); + final char ch2 = str.charAt(2); + if ((!java.lang.Character.isUpperCase(ch1)) || (!java.lang.Character.isUpperCase(ch2))) { + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + if (len == 3) { + return new java.util.Locale(org.apache.commons.lang3.StringUtils.EMPTY, str.substring(1, 3)); + } + if (len < 5) { + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + if (str.charAt(3) != '_') { + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + return new java.util.Locale(org.apache.commons.lang3.StringUtils.EMPTY, str.substring(1, 3), str.substring(4)); + } + final java.lang.String[] split = str.split("_", -1); + final int occurrences = split.length - 1; + switch (occurrences) { + case 0 : + if (org.apache.commons.lang3.StringUtils.isAllLowerCase(str) && ((len == 2) || (len == 3))) { + return new java.util.Locale(str); + } + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + case 1 : + if (((org.apache.commons.lang3.StringUtils.isAllLowerCase(split[0]) && ((split[0].length() == 2) || (split[0].length() == 3))) && (split[1].length() == 2)) && org.apache.commons.lang3.StringUtils.isAllUpperCase(split[1])) { + return new java.util.Locale(split[0], split[1]); + } + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + case 2 : + if (((org.apache.commons.lang3.StringUtils.isAllLowerCase(split[0]) && ((split[0].length() == 2) || (split[0].length() == 3))) && ((split[1].length() == 0) || ((split[1].length() == 2) && org.apache.commons.lang3.StringUtils.isAllUpperCase(split[1])))) && (split[2].length() > 0)) { + return new java.util.Locale(split[0], split[1], split[2]); + } + // $FALL-THROUGH$ + default : + throw new java.lang.IllegalArgumentException("Invalid locale format: " + str); + } + } +} + + //----------------------------------------------------------------------- + /** + *Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr","CA","xxx")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr")] + *+ * + * @param locale the locale to start from + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static List
Obtains the list of locales to search through when performing + * a locale search.
+ * + *+ * localeLookupList(Locale("fr", "CA", "xxx"), Locale("en")) + * = [Locale("fr","CA","xxx"), Locale("fr","CA"), Locale("fr"), Locale("en"] + *+ * + *
The result list begins with the most specific locale, then the + * next more general and so on, finishing with the default locale. + * The list will never contain the same locale twice.
+ * + * @param locale the locale to start from, null returns empty list + * @param defaultLocale the default locale to use if no other is found + * @return the unmodifiable list of Locale objects, 0 being locale, not null + */ + public static ListObtains an unmodifiable list of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable list of available locales + */ + public static ListObtains an unmodifiable set of installed locales.
+ * + *This method is a wrapper around {@link Locale#getAvailableLocales()}. + * It is more efficient, as the JDK method must create a new array each + * time it is called.
+ * + * @return the unmodifiable set of available locales + */ + public static SetChecks if the locale specified is in the list of available locales.
+ * + * @param locale the Locale object to check if it is available + * @return true if the locale is a known locale + */ + public static boolean isAvailableLocale(final Locale locale) { + return availableLocaleList().contains(locale); + } + + //----------------------------------------------------------------------- + /** + *Obtains the list of languages supported for a given country.
+ * + *This method takes a country code and searches to find the + * languages available for that country. Variant locales are removed.
+ * + * @param countryCode the 2 letter country code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ + public static ListObtains the list of countries supported for a given language.
+ * + *This method takes a language code and searches to find the + * countries available for that language. Variant locales are removed.
+ * + * @param languageCode the 2 letter language code, null returns empty + * @return an unmodifiable List of Locale objects, not null + */ + public static List