org.xwiki.properties.converter.Converter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-properties Show documentation

XWiki Commons - Properties

There is a newer version: 8.4-rc-1

Show newest version

/*
 * 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.converter;

import java.lang.reflect.Type;

import org.xwiki.component.annotation.Role;

/**
 * Converter provided value in the provided target type.
 * 
 * The type supported by the converted is indicated in its role.
 * 

 * For example:
 * 

 * 

 *
 *  * @Component
 * public class IntegerConverter implements Converter<java.lang.Integer>
 * 
 *
 * 
 * 
 * When something goes wrong a Converter can throw a {@link ConversionException}.
 *
 * @param  the type in which the provided value has to be converted
 * @version $Id: 35eb4dbb0b09a5c0e75886d1dfc983564a2adbea $
 * @since 2.0M2
 */
@Role
public interface Converter
{
    /**
     * @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
     */
     G convert(Type targetType, Object sourceValue);
}