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

   1 ---
   2 title: fieldMembers
   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   - fields
  12 ---
  13
  14 Controls which `@Generated` annotation members should be added to generated fields. 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 `fieldMembers` 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 public class SomeRepository {
  28
  29     @Generated(
  30         value = "YoSQL",
  31         comments = "DO NOT MODIFY - automatically generated by YoSQL"
  32     )
  33     private Object someField;
  34
  35     // ... rest of generated code
  36
  37 }
  38 ```
  39
  40 ### Option: 'ALL'
  41
  42 Changing the `fieldMembers` configuration option to `ALL` outputs all annotation members.
  43
  44 ```java
  45 package com.example.persistence;
  46
  47 import javax.annotation.processing.Generated;
  48
  49 public class SomeRepository {
  50
  51     @Generated(
  52         value = "YoSQL",
  53         date = "<current_timestamp>",
  54         comments = "DO NOT MODIFY - automatically generated by YoSQL"
  55     )
  56     private Object someField;
  57
  58     // ... rest of generated code
  59
  60 }
  61 ```
  62
  63 ### Option: 'NONE'
  64
  65 Changing the `fieldMembers` configuration option to `NONE` outputs no annotation members.
  66
  67 ```java
  68 package com.example.persistence;
  69
  70 import javax.annotation.processing.Generated;
  71
  72 public class SomeRepository {
  73
  74   @Generated
  75   private Object someField;
  76
  77   // ... rest of generated code
  78
  79 }
  80 ```
  81
  82 ### Option: 'VALUE'
  83
  84 Changing the `fieldMembers` configuration option to `VALUE` outputs only the `value` member.
  85
  86 ```java
  87 package com.example.persistence;
  88
  89 import javax.annotation.processing.Generated;
  90
  91 public class SomeRepository {
  92
  93   @Generated(
  94       value = "YoSQL"
  95   )
  96   private Object someField;
  97
  98   // ... rest of generated code
  99
 100 }
 101 ```
 102
 103 ### Option: 'DATE'
 104
 105 Changing the `fieldMembers` configuration option to `DATE` outputs only the `date` member.
 106
 107 ```java
 108 package com.example.persistence;
 109
 110 import javax.annotation.processing.Generated;
 111
 112 public class SomeRepository {
 113
 114   @Generated(
 115       date = "<current_timestamp>"
 116   )
 117   private Object someField;
 118
 119   // ... rest of generated code
 120
 121 }
 122 ```
 123
 124 ### Option: 'COMMENT'
 125
 126 Changing the `fieldMembers` configuration option to `COMMENT` outputs only the `comment` member.
 127
 128 ```java
 129 package com.example.persistence;
 130
 131 import javax.annotation.processing.Generated;
 132
 133 public class SomeRepository {
 134
 135   @Generated(
 136       comments = "DO NOT MODIFY - automatically generated by YoSQL"
 137   )
 138   private Object someField;
 139
 140   // ... rest of generated code
 141
 142 }
 143 ```
 144
 145 ## Related Options
 146
 147 - [annotateFields](../annotatefields/): Controls whether the `@Generated` annotation should be added at all.
 148 - [fieldComment](../fieldcomment/): Controls the comment used in the `@Generated` annotation.
 149 - [generatorName](../generatorname/): Controls the value used in the `@Generated` annotation.
 150
 151 ## Tooling
 152
 153 ### Maven
 154
 155 In order to use `YoSQL` together with [Maven](https://maven.apache.org/), take a look at the tooling [documentation
 156 for Maven](/tooling/maven/).
 157
 158 {{< maven/config/annotations/fieldMembers >}}
 159
 160 ### Gradle
 161
 162 In order to use `YoSQL` together with [Gradle](https://gradle.org/), take a look at the tooling [documentation for Gradle](/tooling/gradle/).
 163
 164 ```groovy
 165 plugins {
 166   id("wtf.metio.yosql")
 167 }
 168
 169 yosql {
 170   annotations {
 171     fieldMembers = ALL
 172   }
 173 }
 174 ```
 175
 176 ### Bazel
 177
 178 In order to use `YoSQL` together with [Bazel](https://bazel.build/), take a look at the tooling [documentation for
 179 Bazel](/tooling/bazel/).
 180
 181 ### CLI
 182
 183 In order to use YoSQL on the command line, take a look at the tooling [documentation for CLI](/tooling/cli/).
 184
 185 ```shell
 186 $ yosql --annotations-field-members=ALL
 187 ```
 188
 189 The shorter form is available as well:
 190
 191 ```shell
 192 $ yosql --field-members=ALL
 193 ```