org.junit.jupiter.params.converter.StringToObjectConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-jupiter-params Show documentation

Module "junit-jupiter-params" of JUnit 5.

There is a newer version: 5.11.3

/*
 * Copyright 2015-2024 the original author or authors.
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v2.0 which
 * accompanies this distribution and is available at
 *
 * https://www.eclipse.org/legal/epl-v20.html
 */

package org.junit.jupiter.params.converter;

/**
 * Internal API for converting arguments of type {@link String} to a specified
 * target type.
 */
interface StringToObjectConverter {

	/**
	 * Determine if this converter can convert from a {@link String} to the
	 * supplied target type (which is guaranteed to be a wrapper type for
	 * primitives — for example, {@link Integer} instead of {@code int}).
	 */
	boolean canConvert(Class targetType);

	/**
	 * Convert the supplied {@link String} to the supplied target type (which is
	 * guaranteed to be a wrapper type for primitives — for example,
	 * {@link Integer} instead of {@code int}).
	 */
	Object convert(String source, Class targetType) throws Exception;

	/**
	 * Convert the supplied {@link String} to the supplied target type (which is
	 * guaranteed to be a wrapper type for primitives — for example,
	 * {@link Integer} instead of {@code int}).
	 *
	 * The default implementation simply delegates to {@link #convert(String, Class)}.
	 * Can be overridden by concrete implementations of this interface that need
	 * access to the supplied {@link ClassLoader}.
	 */
	default Object convert(String source, Class targetType, ClassLoader classLoader) throws Exception {
		return convert(source, targetType);
	}

}