org.jooq.RecordMapperProvider 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
* ASL 2.0 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.DefaultRecordMapper;
import org.jooq.impl.DefaultRecordMapperProvider;
/**
* A provider for {@link RecordMapper} instances.
*
* In order to inject custom {@link Record} to POJO mapping
* behaviour, users can supply a custom {@link RecordMapperProvider} to their
* {@link Configuration} instances. This provider will be used in any of these
* methods (non-exhaustive list):
*
Cursor
*
* - {@link Cursor#fetchInto(Class)}
* - {@link Cursor#fetchOneInto(Class)}
*
* Record
*
* - {@link Record#into(Class)}
*
* Result
*
* - {@link Result#intoMap(Field, Class)}
* - {@link Result#intoMap(Field[], Class)}
* - {@link Result#intoGroups(Field, Class)}
* - {@link Result#intoGroups(Field[], Class)}
* - {@link Result#into(Class)}
*
* ResultQuery
*
* - {@link ResultQuery#fetchMap(Field, Class)}
* - {@link ResultQuery#fetchMap(Field[], Class)}
* - {@link ResultQuery#fetchGroups(Field, Class)}
* - {@link ResultQuery#fetchGroups(Field[], Class)}
* - {@link ResultQuery#fetchInto(Class)}
* - {@link ResultQuery#fetchOneInto(Class)}
*
* DAO
*
* - Most {@link DAO} methods make use of any of the above methods
*
*
* While not strictly required, it is advisable to implement a
* RecordMapperProvider whose behaviour is consistent with the
* configured {@link RecordUnmapperProvider}.
*
* @author Lukas Eder
* @see RecordMapper
* @see Configuration
*/
@FunctionalInterface
public interface RecordMapperProvider {
/**
* Provide a RecordMapper instance.
*
* Implementations are free to choose whether this method returns new
* instances at every call or whether the same instance is returned
* repetitively.
*
* A RecordMapper instance should be able to map any number of
* records with the same RecordType. For example, for
* {@link Record#into(Class)}, provide() and
* {@link RecordMapper#map(Record)} are called only once. For
* {@link Result#into(Class)}, provide() is called only once,
* but {@link RecordMapper#map(Record)} is called several times, once for
* every Record in the Result.
*
* @param recordType The RecordType of records that shall be
* mapped by the returned RecordMapper.
* @param type The user type that was passed into {@link Record#into(Class)}
* or any other method.
* @return A RecordMapper instance.
* @see RecordMapper
* @see DefaultRecordMapper
* @see DefaultRecordMapperProvider
*/
RecordMapper provide(RecordType recordType, Class type);
}