/*
 * Copyright 2002-2014 the original author or authors.
 *
 * Licensed 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 org.springframework.core.convert.converter;

import org.springframework.core.convert.TypeDescriptor;

Allows a Converter, GenericConverter or ConverterFactory to conditionally execute based on attributes of the source and target TypeDescriptor.

Often used to selectively match custom conversion logic based on the presence of a field or class-level characteristic, such as an annotation or method. For example, when converting from a String field to a Date field, an implementation might return true if the target field has also been annotated with @DateTimeFormat.

As another example, when converting from a String field to an Account field, an implementation might return true if the target Account class defines a public static findAccount(String) method.

Author:Phillip Webb, Keith Donald
See Also:
Since:3.2
/** * Allows a {@link Converter}, {@link GenericConverter} or {@link ConverterFactory} to * conditionally execute based on attributes of the {@code source} and {@code target} * {@link TypeDescriptor}. * * <p>Often used to selectively match custom conversion logic based on the presence of a * field or class-level characteristic, such as an annotation or method. For example, when * converting from a String field to a Date field, an implementation might return * {@code true} if the target field has also been annotated with {@code @DateTimeFormat}. * * <p>As another example, when converting from a String field to an {@code Account} field, * an implementation might return {@code true} if the target Account class defines a * {@code public static findAccount(String)} method. * * @author Phillip Webb * @author Keith Donald * @since 3.2 * @see Converter * @see GenericConverter * @see ConverterFactory * @see ConditionalGenericConverter */
public interface ConditionalConverter {
Should the conversion from sourceType to targetType currently under consideration be selected?
Params:
  • sourceType – the type descriptor of the field we are converting from
  • targetType – the type descriptor of the field we are converting to
Returns:true if conversion should be performed, false otherwise
/** * Should the conversion from {@code sourceType} to {@code targetType} currently under * consideration be selected? * @param sourceType the type descriptor of the field we are converting from * @param targetType the type descriptor of the field we are converting to * @return true if conversion should be performed, false otherwise */
boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType); }