com.landawn.abacus.jdbc.annotation.MappedByKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of abacus-jdbc Show documentation

abacus jdbc

There is a newer version: 3.8.5

/*
 * Copyright (c) 2021, Haiyang Li.
 *
 * 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.landawn.abacus.jdbc.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.HashMap;
import java.util.Map;

/**
 * The result will be merged by {@code keyName} and mapped to {@code map}.
 *
 * For example:
 * 
 * 
 *
 *  @Select("SELECT id, first_name, last_name FROM user WHERE id in ({ids}")
 *  

 *  @MappedByKey("id")
 *  

 *  Map<Long, User> listUser(@BindList("ids") List ids) throws SQLException;
 *
 * 
 * 
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = { ElementType.METHOD })
public @interface MappedByKey {

    /**
     *
     * @return
     * @deprecated using keyName="id" for explicit call.
     */
    @Deprecated
    String value() default "";

    /**
     *
     *
     * @return
     */
    String keyName() default "";

    /**
     *
     *
     * @return
     */
    @SuppressWarnings("rawtypes")
    Class mapClass() default HashMap.class;
}