All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.beanutils.locale.LocaleConvertUtils Maven / Gradle / Ivy

Go to download

BeanUtils provides an easy-to-use but flexible wrapper around reflection and introspection.

There is a newer version: 1.8.3-kuali-4
Show newest version
/*
 * 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.beanutils.locale;

import org.apache.commons.collections.FastHashMap;

import java.util.Locale;

/**
 * 

Utility methods for converting locale-sensitive String scalar values to objects of the * specified Class, String arrays to arrays of the specified Class and * object to locale-sensitive String scalar value.

* *

The implementations for these method are provided by {@link LocaleConvertUtilsBean}. * These static utility method use the default instance. More sophisticated can be provided * by using a LocaleConvertUtilsBean instance.

* * @author Yauheny Mikulski */ public class LocaleConvertUtils { // ----------------------------------------------------- Instance Variables /** *

Gets the Locale which will be used when * no Locale is passed to a method.

* *

For more details see LocaleConvertUtilsBean

* @return the default locale * @see LocaleConvertUtilsBean#getDefaultLocale() */ public static Locale getDefaultLocale() { return LocaleConvertUtilsBean.getInstance().getDefaultLocale(); } /** *

Sets the Locale which will be used when * no Locale is passed to a method.

* *

For more details see LocaleConvertUtilsBean

* * @param locale the default locale * @see LocaleConvertUtilsBean#setDefaultLocale(Locale) */ public static void setDefaultLocale(Locale locale) { LocaleConvertUtilsBean.getInstance().setDefaultLocale(locale); } /** *

Gets applyLocalized.

* *

For more details see LocaleConvertUtilsBean

* * @return true if pattern is localized, * otherwise false * @see LocaleConvertUtilsBean#getApplyLocalized() */ public static boolean getApplyLocalized() { return LocaleConvertUtilsBean.getInstance().getApplyLocalized(); } /** *

Sets applyLocalized.

* *

For more details see LocaleConvertUtilsBean

* * @param newApplyLocalized true if pattern is localized, * otherwise false * @see LocaleConvertUtilsBean#setApplyLocalized(boolean) */ public static void setApplyLocalized(boolean newApplyLocalized) { LocaleConvertUtilsBean.getInstance().setApplyLocalized(newApplyLocalized); } // --------------------------------------------------------- Methods /** *

Convert the specified locale-sensitive value into a String.

* *

For more details see LocaleConvertUtilsBean

* * @param value The Value to be converted * @return the converted value * @see LocaleConvertUtilsBean#convert(Object) */ public static String convert(Object value) { return LocaleConvertUtilsBean.getInstance().convert(value); } /** *

Convert the specified locale-sensitive value into a String * using the conversion pattern.

* *

For more details see LocaleConvertUtilsBean

* * @param value The Value to be converted * @param pattern The convertion pattern * @return the converted value * @see LocaleConvertUtilsBean#convert(Object, String) */ public static String convert(Object value, String pattern) { return LocaleConvertUtilsBean.getInstance().convert(value, pattern); } /** *

Convert the specified locale-sensitive value into a String * using the paticular convertion pattern.

* *

For more details see LocaleConvertUtilsBean

* * @param value The Value to be converted * @param locale The locale * @param pattern The convertion pattern * @return the converted value * @see LocaleConvertUtilsBean#convert(Object, Locale, String) */ public static String convert(Object value, Locale locale, String pattern) { return LocaleConvertUtilsBean.getInstance().convert(value, locale, pattern); } /** *

Convert the specified value to an object of the specified class (if * possible). Otherwise, return a String representation of the value.

* *

For more details see LocaleConvertUtilsBean

* * @param value The String scalar value to be converted * @param clazz The Data type to which this value should be converted. * @return the converted value * @see LocaleConvertUtilsBean#convert(String, Class) */ public static Object convert(String value, Class clazz) { return LocaleConvertUtilsBean.getInstance().convert(value, clazz); } /** *

Convert the specified value to an object of the specified class (if * possible) using the convertion pattern. Otherwise, return a String * representation of the value.

* *

For more details see LocaleConvertUtilsBean

* * @param value The String scalar value to be converted * @param clazz The Data type to which this value should be converted. * @param pattern The convertion pattern * @return the converted value * @see LocaleConvertUtilsBean#convert(String, Class, String) */ public static Object convert(String value, Class clazz, String pattern) { return LocaleConvertUtilsBean.getInstance().convert(value, clazz, pattern); } /** *

Convert the specified value to an object of the specified class (if * possible) using the convertion pattern. Otherwise, return a String * representation of the value.

* *

For more details see LocaleConvertUtilsBean

* * @param value The String scalar value to be converted * @param clazz The Data type to which this value should be converted. * @param locale The locale * @param pattern The convertion pattern * @return the converted value * @see LocaleConvertUtilsBean#convert(String, Class, Locale, String) */ public static Object convert(String value, Class clazz, Locale locale, String pattern) { return LocaleConvertUtilsBean.getInstance().convert(value, clazz, locale, pattern); } /** *

Convert an array of specified values to an array of objects of the * specified class (if possible) using the convertion pattern.

* *

For more details see LocaleConvertUtilsBean

* * @param values Value to be converted (may be null) * @param clazz Java array or element class to be converted to * @param pattern The convertion pattern * @return the converted value * @see LocaleConvertUtilsBean#convert(String[], Class, String) */ public static Object convert(String[] values, Class clazz, String pattern) { return LocaleConvertUtilsBean.getInstance().convert(values, clazz, pattern); } /** *

Convert an array of specified values to an array of objects of the * specified class (if possible).

* *

For more details see LocaleConvertUtilsBean

* * @param values Value to be converted (may be null) * @param clazz Java array or element class to be converted to * @return the converted value * @see LocaleConvertUtilsBean#convert(String[], Class) */ public static Object convert(String[] values, Class clazz) { return LocaleConvertUtilsBean.getInstance().convert(values, clazz); } /** *

Convert an array of specified values to an array of objects of the * specified class (if possible) using the convertion pattern.

* *

For more details see LocaleConvertUtilsBean

* * @param values Value to be converted (may be null) * @param clazz Java array or element class to be converted to * @param locale The locale * @param pattern The convertion pattern * @return the converted value * @see LocaleConvertUtilsBean#convert(String[], Class, Locale, String) */ public static Object convert(String[] values, Class clazz, Locale locale, String pattern) { return LocaleConvertUtilsBean.getInstance().convert(values, clazz, locale, pattern); } /** *

Register a custom {@link LocaleConverter} for the specified destination * Class, replacing any previously registered converter.

* *

For more details see LocaleConvertUtilsBean

* * @param converter The LocaleConverter to be registered * @param clazz The Destination class for conversions performed by this * Converter * @param locale The locale * @see LocaleConvertUtilsBean#register(LocaleConverter, Class, Locale) */ public static void register(LocaleConverter converter, Class clazz, Locale locale) { LocaleConvertUtilsBean.getInstance().register(converter, clazz, locale); } /** *

Remove any registered {@link LocaleConverter}.

* *

For more details see LocaleConvertUtilsBean

* * @see LocaleConvertUtilsBean#deregister() */ public static void deregister() { LocaleConvertUtilsBean.getInstance().deregister(); } /** *

Remove any registered {@link LocaleConverter} for the specified locale.

* *

For more details see LocaleConvertUtilsBean

* * @param locale The locale * @see LocaleConvertUtilsBean#deregister(Locale) */ public static void deregister(Locale locale) { LocaleConvertUtilsBean.getInstance().deregister(locale); } /** *

Remove any registered {@link LocaleConverter} for the specified locale and Class.

* *

For more details see LocaleConvertUtilsBean

* * @param clazz Class for which to remove a registered Converter * @param locale The locale * @see LocaleConvertUtilsBean#deregister(Class, Locale) */ public static void deregister(Class clazz, Locale locale) { LocaleConvertUtilsBean.getInstance().deregister(clazz, locale); } /** *

Look up and return any registered {@link LocaleConverter} for the specified * destination class and locale; if there is no registered Converter, return * null.

* *

For more details see LocaleConvertUtilsBean

* * @param clazz Class for which to return a registered Converter * @param locale The Locale * @return The registered locale Converter, if any * @see LocaleConvertUtilsBean#lookup(Class, Locale) */ public static LocaleConverter lookup(Class clazz, Locale locale) { return LocaleConvertUtilsBean.getInstance().lookup(clazz, locale); } /** *

Look up and return any registered FastHashMap instance for the specified locale.

* *

For more details see LocaleConvertUtilsBean

* * @param locale The Locale * @return The FastHashMap instance contains the all {@link LocaleConverter} types for * the specified locale. * @see LocaleConvertUtilsBean#lookup(Locale) * @deprecated This method will be modified to return a Map in the next release. */ protected static FastHashMap lookup(Locale locale) { return LocaleConvertUtilsBean.getInstance().lookup(locale); } /** *

Create all {@link LocaleConverter} types for specified locale.

* *

For more details see LocaleConvertUtilsBean

* * @param locale The Locale * @return The FastHashMap instance contains the all {@link LocaleConverter} types * for the specified locale. * @see LocaleConvertUtilsBean#create(Locale) * @deprecated This method will be modified to return a Map in the next release. */ protected static FastHashMap create(Locale locale) { return LocaleConvertUtilsBean.getInstance().create(locale); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy