yosql-models/yosql-models-meta/src/main/java/wtf/metio/yosql/models/meta/ConfigurationSetting.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 http://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.models.meta;
   9
  10 import com.squareup.javapoet.AnnotationSpec;
  11 import com.squareup.javapoet.TypeName;
  12 import org.immutables.value.Value;
  13
  14 import java.util.Collections;
  15 import java.util.List;
  16 import java.util.Optional;
  17
  18 /**
  19  * Represents a single configuration setting.
  20  */
  21 @Value.Immutable
  22 public interface ConfigurationSetting {
  23
  24     //region builders
  25
  26     static ImmutableConfigurationSetting.Builder builder() {
  27         return ImmutableConfigurationSetting.builder();
  28     }
  29
  30     static ImmutableConfigurationSetting copyOf(final ConfigurationSetting setting) {
  31         return ImmutableConfigurationSetting.copyOf(setting);
  32     }
  33
  34     //endregion
  35
  36     String name();
  37
  38     String description();
  39
  40     TypeName type();
  41
  42     Optional<String> explanation();
  43
  44     Optional<TypeName> cliType();
  45
  46     Optional<TypeName> gradleType();
  47
  48     Optional<TypeName> mavenType();
  49
  50     Optional<Object> value();
  51
  52     Optional<Object> cliValue();
  53
  54     Optional<Object> gradleValue();
  55
  56     Optional<Object> mavenValue();
  57
  58     /**
  59      * @return The optional list of tags associated with this configuration setting.
  60      */
  61     List<String> tags();
  62
  63     /**
  64      * @return The optional list of examples for this configuration setting.
  65      */
  66     List<ConfigurationExample> examples();
  67
  68     //region defaults
  69
  70     @Value.Default
  71     default List<AnnotationSpec> immutableAnnotations() {
  72         return Collections.emptyList();
  73     }
  74
  75     @Value.Default
  76     default List<AnnotationSpec> cliAnnotations() {
  77         return Collections.emptyList();
  78     }
  79
  80     @Value.Default
  81     default List<AnnotationSpec> gradleAnnotations() {
  82         return Collections.emptyList();
  83     }
  84
  85     @Value.Default
  86     default List<AnnotationSpec> mavenAnnotations() {
  87         return Collections.emptyList();
  88     }
  89
  90     //endregion
  91
  92 }