org.seasar.doma.AnnotateWith 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;
import org.seasar.doma.jdbc.Config;

/**
 * Indicates that a generated code that implements the annotated interface is annotated with some
 * annotations.
 *
 * This annotation is mainly intended to inject a {@link Config} instance to a DAO
 * implementation's constructor.
 *
 * 
There are 2 ways to use this annotation:
 *
 * 

 *   annotate directly
 *   
annotate indirectly
 * 
 *
 * annotate directly:
 *
 * 
 * @Dao
 * @AnnotateWith(annotations = {
 *   @Annotation(target = AnnotationTarget.CONSTRUCTOR, type = javax.inject.Inject.class),
 *   @Annotation(target = AnnotationTarget.CONSTRUCTOR_PARAMETER, type = javax.inject.Named.class, elements = "\"config\"") })
 * public interface EmployeeDao {
 *    ...
 * }
 * 
 *
 * annotate indirectly:
 *
 *  * @AnnotateWith(annotations = {
 *         @Annotation(target = AnnotationTarget.CONSTRUCTOR, type = javax.inject.Inject.class),
 *         @Annotation(target = AnnotationTarget.CONSTRUCTOR_PARAMETER, type = javax.inject.Named.class, elements = "\"config\"") })
 * public @interface InjectConfig {
 * }
 * 
 *
 *  * @Dao
 * @InjectConfig
 * public interface EmployeeDao {
 *    ...
 * }
 * 
 */
@SuppressWarnings("deprecation")
@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnotateWith {

  /**
   * @return the {@link Annotation} array.
   */
  Annotation[] annotations();
}