org.jooq.RecordUnmapperProvider Maven / Gradle / Ivy
/*
* 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.DefaultRecordUnmapper;
import org.jooq.impl.DefaultRecordUnmapperProvider;
import org.jetbrains.annotations.NotNull;
/**
* A provider for {@link RecordUnmapper} instances.
*
* In order to inject custom POJO to {@link Record} mapping
* behaviour, users can supply a custom {@link RecordUnmapperProvider} to their
* {@link Configuration} instances. This provider will be used in any of these
* methods (non-exhaustive list):
*
Record
*
* - {@link Record#from(Object)}
* - {@link Record#from(Object, Field...)}
* - {@link Record#from(Object, int...)}
* - {@link Record#from(Object, Name...)}
* - {@link Record#from(Object, String...)}
*
* DSLContext
*
* - {@link DSLContext#newRecord(Table, Object)}
*
*
* While not strictly required, it is advisable to implement a
* RecordUnmapperProvider whose behaviour is consistent with the
* configured {@link RecordMapperProvider}.
*
* @author Lukas Eder
* @see RecordUnmapper
* @see Configuration
*/
@FunctionalInterface
public interface RecordUnmapperProvider {
/**
* Provide a RecordUnmapper instance.
*
* Implementations are free to choose whether this method returns new
* instances at every call or whether the same instance is returned
* repetitively.
*
* @param type The user type that was passed into
* {@link Record#from(Object)} or any other method.
* @param recordType The RecordType of records that shall be
* mapped by the returned RecordUnmapper.
* @return A RecordUnmapper instance.
* @see RecordUnmapper
* @see DefaultRecordUnmapper
* @see DefaultRecordUnmapperProvider
*/
@NotNull
RecordUnmapper provide(Class type, RecordType recordType);
}