1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.commons.beanutils2.converters;
20
21 import java.util.Locale;
22
23 /**
24 * {@link org.apache.commons.beanutils2.Converter} implementation that handles conversion to and from {@link Locale}.
25 *
26 * @since 2.0.0
27 */
28 public class LocaleConverter extends AbstractConverter<Locale> {
29
30 /**
31 * Construct a <strong>{@link Locale}</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
32 */
33 public LocaleConverter() {
34 }
35
36 /**
37 * Constructs a {@link org.apache.commons.beanutils2.Converter} that will return the specified default value if a conversion error occurs.
38 *
39 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
40 */
41 public LocaleConverter(final Locale defaultValue) {
42 super(defaultValue);
43 }
44
45 /**
46 * Converts the specified input object into an output object of the specified type.
47 *
48 * @param type Data type to which this value should be converted.
49 * @param value The String property value to convert.
50 * @return A {@link Locale} which represents the configuration property value.
51 * @throws NullPointerException If the value is null.
52 */
53 @Override
54 protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
55 if (Locale.class.isAssignableFrom(type)) {
56 final String stringValue = toString(value);
57 return type.cast(Locale.forLanguageTag(stringValue));
58 }
59
60 throw conversionException(type, value);
61 }
62
63 /**
64 * Gets the default type this {@code Converter} handles.
65 *
66 * @return The default type this {@code Converter} handles.
67 * @since 2.0.0
68 */
69 @Override
70 protected Class<Locale> getDefaultType() {
71 return Locale.class;
72 }
73 }