org.jooq.ConverterProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation

There is a newer version: 3.19.16

/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jooq.impl.DefaultConverterProvider;

import org.jetbrains.annotations.Nullable;

/**
 * A ConverterProvider provides {@link Converter} implementations
 * for any combination of types <T> and
 * <U>.
 * 
 * ConverterProvider can be used together with
 * {@link RecordMapper}, e.g. when mapping {@link JSON} or {@link XML} data
 * types onto POJO types using third party libraries like Jackson, Gson, JAXB,
 * or others.
 *
 * @author Lukas Eder
 */
@FunctionalInterface
public interface ConverterProvider {

    /**
     * Provide a converter that can convert between <T> and
     * <U> types.
     *
     * @return The converter for <T, U>, or null
     *         if no such converter could be provided, in case of which jOOQ's
     *         {@link DefaultConverterProvider} applies.
     */
    @Nullable
     Converter provide(Class tType, Class uType);
}