org.seasar.doma.Dao Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doma-core Show documentation

DAO Oriented Database Mapping Framework for Java

There is a newer version: 3.3.0

/*
 * Copyright Doma Authors
 *
 * 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
 *
 *     https://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 org.seasar.doma;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Indicates a DAO interface.
 *
 * The annotated interface must be a top level interface.
 *
 * 
 * @Dao
 * public interface EmployeeDao {
 *
 *     @Insert
 *     int insert(Employee employee);
 * }
 * 
 *
 * The interface can extend another DAO interface:
 *
 * 
 * @Dao
 * public interface WorkerDao {
 *
 *     @Insert
 *     int insert(Worker worker);
 * }
 * 
 *
 *  * @Dao
 * public interface EmployeeDao extends WorkerDao {
 *
 *     @Insert
 *     int insert(Employee employee);
 * }
 * 
 *
 * @see ArrayFactory
 * @see BatchDelete
 * @see BatchInsert
 * @see BatchUpdate
 * @see BlobFactory
 * @see ClobFactory
 * @see Delete
 * @see Function
 * @see Insert
 * @see NClobFactory
 * @see Procedure
 * @see Select
 * @see Script
 * @see SqlProcessor
 * @see Update
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Dao {

  /**
   * @return the access level of the DAO implementation class.
   */
  AccessLevel accessLevel() default AccessLevel.PUBLIC;
}