yosql-codegen/src/main/java/wtf/metio/yosql/codegen/blocks/Annotations.java

   1 /*
   2  * This file is part of yosql. It is subject to the license terms in the LICENSE file found in the top-level
   3  * directory of this distribution and at https://creativecommons.org/publicdomain/zero/1.0/. No part of yosql,
   4  * including this file, may be copied, modified, propagated, or distributed except according to the terms contained
   5  * in the LICENSE file.
   6  */
   7
   8 package wtf.metio.yosql.codegen.blocks;
   9
  10 import com.squareup.javapoet.AnnotationSpec;
  11 import wtf.metio.yosql.models.immutables.SqlConfiguration;
  12
  13 /**
  14  * Generates annotations for classes, fields, and methods.
  15  */
  16 public interface Annotations {
  17
  18     /**
  19      * @return Generated annotations for a single class.
  20      */
  21     Iterable<AnnotationSpec> generatedClass();
  22
  23     /**
  24      * @return Generated annotations for a single field.
  25      */
  26     Iterable<AnnotationSpec> generatedField();
  27
  28     /**
  29      * @return Generated annotations for a single method.
  30      */
  31     Iterable<AnnotationSpec> generatedMethod();
  32
  33     /**
  34      * @return User specified annotations for generated repositories and their interfaces.
  35      */
  36     Iterable<AnnotationSpec> generatedRepository();
  37
  38     /**
  39      * @return User specified annotations for generated methods.
  40      */
  41     Iterable<AnnotationSpec> generatedMethod(SqlConfiguration configuration);
  42
  43     /**
  44      * @return User specified annotations for generated constructors.
  45      */
  46     Iterable<AnnotationSpec> generatedConstructor();
  47
  48 }