com.speedment.component.resultset.ResultSetMapperComponent Maven / Gradle / Ivy

Go to download

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

There is a newer version: 3.0.0-EA

/**
 *
 * Copyright (c) 2006-2016, Speedment, Inc. All Rights Reserved.
 *
 * 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 com.speedment.component.resultset;

import com.speedment.annotation.Api;
import com.speedment.component.Component;
import com.speedment.config.db.parameters.DbmsType;

/**
 * The JavaTypeMapperComponent provides a mapping from a certain DbmsType and
 * Class to a certain JavaTypeMapping. By implementing custom implementation of
 * this interface, arbitrary mappings may be carried out.
 *
 * @author  Per Minborg
 * @since   2.0
 */
@Api(version = "2.3")
public interface ResultSetMapperComponent extends Component {

    @Override
    default Class getComponentClass() {
        return ResultSetMapperComponent.class;
    }

    /**
     * Gets the mapping from the javaClass to the {@link ResultSetMapping}. If a 
     * specific mapping for the given {@link DbmsType} is present, that mapping 
     * is selected over the general mapping for any {@link DbmsType}.
     *
     * @param         the java class type to map
     * @param dbmsType   the Dbms type
     * @param javaClass  the java class to map
     * @return           the mapping
     */
     ResultSetMapping apply(DbmsType dbmsType, Class javaClass);

    /**
     * Gets the mapping from the javaClass to the {@link ResultSetMapping}. The 
     * mapping will not consider {@link DbmsType} specific mappings.
     *
     * @param         the java class type to map
     * @param javaClass  the java class to map
     * @return           the mapping
     */
     ResultSetMapping apply(Class javaClass);

}