yosql-website/content/configuration/annotations/classMembers.md

   1 ---
   2 title: classMembers
   3 date: 2019-09-27T18:51:08+02:00
   4 menu:
   5   main:
   6     parent: Annotations
   7 categories:
   8   - Configuration
   9 tags:
  10   - annotations
  11   - classes
  12 ---
  13
  14 Controls which `@Generated` annotation members should be added to generated classes. Defaults to `WITHOUT_DATE` which uses all members except `date` in order to support reproducible builds (otherwise the generated classes would change on each generation).
  15
  16 ## Configuration Options
  17
  18 ### Option: 'WITHOUT_DATE'
  19
  20 The default value of the `classMembers` configuration option is `WITHOUT_DATE`. Setting the option to `WITHOUT_DATE` therefore produces the same code generated as the default configuration.
  21
  22 ```java
  23 package com.example.persistence;
  24
  25 import javax.annotation.processing.Generated;
  26
  27 @Generated(
  28     value = "YoSQL",
  29     comments = "DO NOT MODIFY - automatically generated by YoSQL"
  30 )
  31 public class SomeRepository {
  32
  33     // ... rest of generated code
  34
  35 }
  36 ```
  37
  38 ### Option: 'ALL'
  39
  40 Changing the `classMembers` configuration option to `ALL` outputs all annotation members.
  41
  42 ```java
  43 package com.example.persistence;
  44
  45 import javax.annotation.processing.Generated;
  46
  47 @Generated(
  48     value = "YoSQL",
  49     date = "<current_timestamp>",
  50     comments = "DO NOT MODIFY - automatically generated by YoSQL"
  51 )
  52 public class SomeRepository {
  53
  54   // ... rest of generated code (same as above)
  55
  56 }
  57 ```
  58
  59 ### Option: 'NONE'
  60
  61 Changing the `classMembers` configuration option to `NONE` outputs no annotation members.
  62
  63 ```java
  64 package com.example.persistence;
  65
  66 import javax.annotation.processing.Generated;
  67
  68 @Generated
  69 public class SomeRepository {
  70
  71     // ... rest of generated code (same as above)
  72
  73 }
  74 ```
  75
  76 ### Option: 'VALUE'
  77
  78 Changing the `classMembers` configuration option to `VALUE` outputs only the `value` member.
  79
  80 ```java
  81 package com.example.persistence;
  82
  83 import javax.annotation.processing.Generated;
  84
  85 @Generated(
  86     value = "YoSQL"
  87 )
  88 public class SomeRepository {
  89
  90   // ... rest of generated code (same as above)
  91
  92 }
  93 ```
  94
  95 ### Option: 'DATE'
  96
  97 Changing the `classMembers` configuration option to `DATE` outputs only the `date` member.
  98
  99 ```java
 100 package com.example.persistence;
 101
 102 import javax.annotation.processing.Generated;
 103
 104 @Generated(
 105     date = "<current_timestamp>"
 106 )
 107 public class SomeRepository {
 108
 109   // ... rest of generated code (same as above)
 110
 111 }
 112 ```
 113
 114 ### Option: 'COMMENT'
 115
 116 Changing the `classMembers` configuration option to `COMMENT` outputs only the `comment` member.
 117
 118 ```java
 119 package com.example.persistence;
 120
 121 import javax.annotation.processing.Generated;
 122
 123 @Generated(
 124     comment = "DO NOT MODIFY - automatically generated by YoSQL"
 125 )
 126 public class SomeRepository {
 127
 128   // ... rest of generated code (same as above)
 129
 130 }
 131 ```
 132
 133 ## Related Options
 134
 135 - [annotateClasses](../annotateclasses/): Controls whether the `@Generated` annotation should be added at all.
 136 - [classComment](../classcomment/): Controls the comment used in the `@Generated` annotation.
 137 - [generatorName](../generatorname/): Controls the value used in the `@Generated` annotation.
 138
 139 ## Tooling
 140
 141 ### Maven
 142
 143 In order to use `YoSQL` together with [Maven](https://maven.apache.org/), take a look at the tooling [documentation
 144 for Maven](/tooling/maven/).
 145
 146 {{< maven/config/annotations/classMembers >}}
 147
 148 ### Gradle
 149
 150 In order to use `YoSQL` together with [Gradle](https://gradle.org/), take a look at the tooling [documentation for Gradle](/tooling/gradle/).
 151
 152 ```groovy
 153 plugins {
 154   id("wtf.metio.yosql")
 155 }
 156
 157 yosql {
 158   annotations {
 159     classMembers = ALL
 160   }
 161 }
 162 ```
 163
 164 ### Bazel
 165
 166 In order to use `YoSQL` together with [Bazel](https://bazel.build/), take a look at the tooling [documentation for
 167 Bazel](/tooling/bazel/).
 168
 169 ### CLI
 170
 171 In order to use YoSQL on the command line, take a look at the tooling [documentation for CLI](/tooling/cli/).
 172
 173 ```shell
 174 $ yosql --annotations-class-members=ALL
 175 ```
 176
 177 The shorter form is available as well:
 178
 179 ```shell
 180 $ yosql --class-members=ALL
 181 ```