org.xwiki.properties.ConverterManager Maven / Gradle / Ivy
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.properties;
import java.lang.reflect.Type;
import org.xwiki.component.annotation.Role;
import org.xwiki.properties.converter.Converter;
/**
* Simple API to do universal conversion between two types.
*
* To add support for another target type, implements a new {@link org.xwiki.properties.converter.Converter} component
*
* @version $Id: dbab3f6b3e99306db08147cf60024fd94d011c58 $
* @since 2.0M2
*/
@Role
public interface ConverterManager
{
/**
* Convert provided value into the provided target type.
*
* @param the type in which the provided value has to be converted
* @param targetType the type in which the provided value has to be converted
* @param sourceValue the value to convert
* @return the converted value
* @since 3.0M1
*/
T convert(Type targetType, Object sourceValue);
/**
* @param the type in which the provided value has to be converted
* @param targetType the type for which the converter has been registered
* @return the converter associated to the provided type or null if none could be found
* @since 9.0RC1
*/
default Converter getConverter(Type targetType)
{
return null;
}
}