001/**
002 * The MIT License (MIT)
003 *
004 * Copyright (c) 2017 tools4j.org (Marco Terzer)
005 *
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 *
013 * The above copyright notice and this permission notice shall be included in all
014 * copies or substantial portions of the Software.
015 *
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022 * SOFTWARE.
023 */
024package org.tools4j.spockito;
025
026import java.lang.reflect.Type;
027
028/**
029 * Handles the conversion of string values to arbitrary target types. Value conversion takes part when the
030 * {@link org.tools4j.spockito.Spockito.Unroll} table data defined in string form is assigned to test class fields or
031 * parameters of a test method.
032 */
033public interface ValueConverter {
034    /**
035     * Converts the given string value into the target type specified by raw and generic type.
036     *
037     * @param type          the target type in raw form, for instance {@code int.class}, {@code List.class} etc.
038     * @param genericType   the generic target type, same as type for non-generic types; generic type examples are
039     *                      {@code List<String>}, {@code Map<String, Integer>} etc.
040     * @param value         the value to convert, may be null
041     * @param <T> the target type parameter
042     * @return the converted value
043     */
044    <T> T convert(Class<T> type, Type genericType, String value);
045}