Class ConfigurationSetting.Builder

java.lang.Object
oracle.dbtools.plugin.api.conf.ConfigurationSetting.Builder
Enclosing class:
ConfigurationSetting

public static class ConfigurationSetting.Builder extends Object
Builds ConfigurationSetting instances
Author:
cdivilly
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • build

      public ConfigurationSetting build()
      Build the ConfigurationSetting instance
      Returns:
      ConfigurationSetting instance
    • defaultValue

      public ConfigurationSetting.Builder defaultValue(Object defaultValue)
      Specify the default value of this setting, if no explicit value is found in the SecureConfiguration.
      Parameters:
      defaultValue - The default value to use for the setting, if no explicit value is provided in the configuration
      Returns:
      self
    • description

      public ConfigurationSetting.Builder description(Translatable description)
    • global

      public ConfigurationSetting.Builder global(boolean global)
      Specify whether this is a global setting or not
      Parameters:
      global - true if the setting is global, false otherwise
      Returns:
      self
    • override

      public ConfigurationSetting.Builder override(boolean override)
      Specify whether this setting can be overridden at runtime.
      Parameters:
      override - true if this setting can be overridden, false otherwise
      Returns:
      self
    • secure

      public ConfigurationSetting.Builder secure(boolean secure)
      Specify whether this setting contains sensitive data such as passwords.
      Parameters:
      secure - true if this setting is sensitive, false otherwise
      Returns:
      self
    • status

      Specify the status of the configuration setting
      Parameters:
      status - The status of the configuration setting
      Returns:
    • type

      public ConfigurationSetting.Builder type(Class<?> type)
      Specify the data type of the setting
      Parameters:
      type - The data type
      Returns:
      self