net.hasor.utils.convert.ConverterUtils Maven / Gradle / Ivy
/*
* 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 net.hasor.utils.convert;
/**
* Utility methods for converting String scalar values to objects of the
* specified Class, String arrays to arrays of the specified Class.
*
* For more details, see ConverterBean which provides the
* implementations for these methods.
*
* @author Craig R. McClanahan
* @author Ralph Schaer
* @author Chris Audley
* @version $Revision: 556229 $ $Date: 2007-07-14 07:11:19 +0100 (Sat, 14 Jul 2007) $
* @see ConverterBean
*/
@SuppressWarnings("rawtypes")
public class ConverterUtils {
// --------------------------------------------------------- Public Classes
/**
* Convert the specified value into a String.
*
* For more details see ConverterBean.
*
* @param value Value to be converted (may be null)
* @return The converted String value
* @see ConverterBean#convert(Object)
*/
public static String convert(final Object value) {
return ConverterBean.getInstance().convert(value);
}
/**
* 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 ConverterBean.
*
* @param value Value to be converted (may be null)
* @param clazz Java class to be converted to
* @return The converted value
* @see ConverterBean#convert(String, Class)
*/
public static Object convert(final String value, final Class clazz) {
return ConverterBean.getInstance().convert(value, clazz);
}
/**
* Convert an array of specified values to an array of objects of the
* specified class (if possible).
*
* For more details see ConverterBean.
*
* @param values Array of values to be converted
* @param clazz Java array or element class to be converted to
* @return The converted value
* @see ConverterBean#convert(String[], Class)
*/
public static Object convert(final String[] values, final Class clazz) {
return ConverterBean.getInstance().convert(values, clazz);
}
/**
* Convert the value to an object of the specified class (if
* possible).
*
* @param value Value to be converted (may be null)
* @param targetType Class of the value to be converted to
* @return The converted value
* @exception ConversionException if thrown by an underlying Converter
*/
public static Object convert(final Class targetType, final Object value) {
if (targetType.isInstance(value)) {
return value;
}
return ConverterBean.getInstance().convert(value, targetType);
}
/**
* Remove all registered {@link Converter}s, and re-establish the
* standard Converters.
*
* For more details see ConverterBean.
*
* @see ConverterBean#deregister()
*/
public static void deregister() {
ConverterBean.getInstance().deregister();
}
/**
* Remove any registered {@link Converter} for the specified destination
* Class.
*
* For more details see ConverterBean.
*
* @param clazz Class for which to remove a registered Converter
* @see ConverterBean#deregister(Class)
*/
public static void deregister(final Class clazz) {
ConverterBean.getInstance().deregister(clazz);
}
/**
* Look up and return any registered {@link Converter} for the specified
* destination class; if there is no registered Converter, return
* null.
*
* For more details see ConverterBean.
*
* @param clazz Class for which to return a registered Converter
* @return The registered {@link Converter} or null if not found
* @see ConverterBean#lookup(Class)
*/
public static Converter lookup(final Class clazz) {
return ConverterBean.getInstance().lookup(clazz);
}
/**
* Look up and return any registered {@link Converter} for the specified
* source and destination class; if there is no registered Converter,
* return null.
*
* @param sourceType Class of the value being converted
* @param targetType Class of the value to be converted to
* @return The registered {@link Converter} or null if not found
*/
public static Converter lookup(final Class sourceType, final Class targetType) {
return ConverterBean.getInstance().lookup(sourceType, targetType);
}
/**
* Register a custom {@link Converter} for the specified destination
* Class, replacing any previously registered Converter.
*
* For more details see ConverterBean.
*
* @param converter Converter to be registered
* @param clazz Destination class for conversions performed by this Converter
* @see ConverterBean#register(Converter, Class)
*/
public static void register(final Converter converter, final Class clazz) {
ConverterBean.getInstance().register(converter, clazz);
}
}