Package com.blueriq.component.api.properties

Interface PropertyService

public interface PropertyService
Interface for a service that reads configuration properties in several formats

  • Method Details

    • readString

      String readString(String key)
      Returns the string value for the given key
      Parameters:
      key - the name of the property to read
      Returns:
      the value for the given key, or null if the key cannot be resolved

    • readMultiValueString

      List<String> readMultiValueString(String key)
      Returns the string values for the given key. Values are splitted by a comma and trimmed afterwards
      Parameters:
      key - the name of the property to read
      Returns:
      a list of values for the given key, or null if the key cannot be resolved

    • readInteger

      Integer readInteger(String key)
      Returns the integer value for the given key
      Parameters:
      key - the name of the property to read
      Returns:
      the value for the given key, or null if the key cannot be resolved or the value is empty
      Throws:
      IllegalArgumentException - in case the value can not be converted to an integer

    • readInteger

      int readInteger(String key, int defaultValue)
      Returns the integer value for the given key
      Parameters:
      key - the name of the property to read
      defaultValue - the value to return if the key cannot be resolved or the value is empty
      Returns:
      the value for the given key, or defaultValue if the key cannot be resolved or the value is empty
      Throws:
      IllegalArgumentException - in case the value can not be converted to an integer

    • readMap

      Map<String,String> readMap(String key)
      Returns a map containing all configured key-value pairs for the given key
      Parameters:
      key - the name of the property to read
      Returns:
      a map containing key-value pairs, never null