Package com.helger.config.source.appl

Class ConfigurationSourceFunction

java.lang.Object
com.helger.config.source.AbstractConfigurationSource
com.helger.config.source.appl.ConfigurationSourceFunction
All Implemented Interfaces:
IConfigurationSource, IConfigurationValueProvider
@Immutable public class ConfigurationSourceFunction extends AbstractConfigurationSource
Default implementation of IConfigurationSource for application based configuration sources. The main values are provided using a custom Function.
Author:
Philip Helger

  • Field Details

  • Constructor Details

    • ConfigurationSourceFunction

      public ConfigurationSourceFunction(@Nonnull UnaryOperator<String> aValueProvider)
      Constructor with default priority
      Parameters:
      aValueProvider - The value provider to be used. May not be null.

    • ConfigurationSourceFunction

      public ConfigurationSourceFunction(int nPriority, @Nonnull UnaryOperator<String> aValueProvider)
      Constructor
      Parameters:
      nPriority - Configuration source priority.
      aValueProvider - The value provider to be used. May not be null.

  • Method Details

    • getValueProvider

      @Nonnull public final UnaryOperator<String> getValueProvider()
      Returns:
      The value provider as passed in the constructor. Never null.

    • isInitializedAndUsable

      public boolean isInitializedAndUsable()
      Returns:
      true if the file was successfully initialized and can be used as a configuration source.

    • getConfigurationValue

      @Nullable public ConfiguredValue getConfigurationValue(@Nonnull @Nonempty String sKey)
      Description copied from interface: IConfigurationValueProvider
      Get the configuration value with the provided key.
      Parameters:
      sKey - The key to be retrieved. May neither be null nor empty.
      Returns:
      null if no such value is available.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AbstractConfigurationSource

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractConfigurationSource

    • toString

      public String toString()
      Overrides:
      toString in class AbstractConfigurationSource