format.bind.converter.spi.FieldConverterProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jformatb-api Show documentation

Turn formatted text to java bean and vice versa

There is a newer version: 0.4

/*
 * Copyright 2024 jFormat-B
 *
 * 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 format.bind.converter.spi;

import format.bind.Formatter;
import format.bind.converter.FieldConverter;

/**
 * Service Provider Interface for {@link FieldConverter}.
 * 
 * @author Yannick Ebongue
 * 
 */
public interface FieldConverterProvider {

	/**
	 * Obtain the {@link FieldConverter} of the specified field type and converter type.
	 * @param  The Java type of the field.
	 * @param fieldType The class instance of the field Java type.
	 * @param converterType The class instance of the field converter to obtain.
	 * @return The field converter instance.
	 */
	 FieldConverter getConverter(final Class fieldType,
			Class> converterType);

	/**
	 * Obtain the {@link FieldConverter} of the specified field type.
	 * @param  The Java type of the field.
	 * @param fieldType The class instance of the field Java type.
	 * @return The field converter instance.
	 */
	 FieldConverter getConverter(final Class fieldType);

	/**
	 * Obtain the {@link FieldConverter} of the specified {@code formatter}.
	 * @param  The type of the {@link Formatter} type.
	 * @param formatter The formatter
	 * @return The field converter instance.
	 */
	 FieldConverter getConverter(final Formatter formatter);

}