Package org.itsallcode.whiterabbit.api

Interface PluginConfiguration

public interface PluginConfiguration
The configuration of a Plugin that allows retrieving configuration values from the WhiteRabbit properties file ~/.whiterabbit.properties.

  • Method Details

    • getMandatoryValue

      String getMandatoryValue(String propertyName)
      Get property pluginId.propertyName from the config file. Throws an exception if the property is not available.
      Parameters:
      propertyName - the property name to get.
      Returns:
      the value of the property.
      Throws:
      RuntimeException - if the property is not available in the config file.

    • getOptionalValue

      Optional<String> getOptionalValue(String propertyName)
      Get property pluginId.propertyName from the config file. If the property is not available then return empty Optional.
      Parameters:
      propertyName - the property name to get.
      Returns:
      the value of the property.

    • getDataDir

      Path getDataDir()
      Get the Path to the data directory.
      Returns:
      the Path to the data directory.