Class ConfigurationDefinition<DataType>

    • Method Detail

      • getCurrentConfiguredValue

        public ConfiguredValue<DataType> getCurrentConfiguredValue()
        Full details on the current value for this definition. Will always return a ConfiguredValue,
      • getKey

        public String getKey()
        The standard configuration key for this definition. See the ConfigurationDefinition class-level docs on key format.
      • getAliasKeys

        public Set<String> getAliasKeys()
        alternate configuration keys to check for values. Used for backwards compatibility.
      • getDataType

        public Class<DataType> getDataType()
        the type of data this definition returns.
      • getDescription

        public String getDescription()
        A user-friendly description of this definition. This will be exposed to end-users in generated help.
      • getDefaultValue

        public DataType getDefaultValue()
        The default value used by this definition if no value is currently configured.

        NOTE: this is only used if none of the ConfigurationValueProviders have a configuration for the property. Even if some return "null", that is still considered a provided value to use rather than this default.

      • getCommonlyUsed

        public boolean getCommonlyUsed()
        Returns true if this is configuration users are often interested in setting. Used to simplify generated help by hiding less commonly used settings.
      • isInternal

        public boolean isInternal()
        Return true if this configuration is for internal and/or programmatic use only. End-user facing integrations should not expose internal configurations directly.
      • isHidden

        public boolean isHidden()
        Return true if this configuration should not be printed to the console for any help command.
      • hashCode

        public int hashCode()
        hashCode in class Object
      • equalsKey

        public boolean equalsKey​(String key)
        Return true if the given key matches this definition.