Package org.apache.pinot.spi.env

Class CommonsConfigurationUtils

  • public abstract class CommonsConfigurationUtils
extends Object
    Provide utility functions to manipulate Apache Commons Configuration instances.

    • Method Summary

      Modifier and Type Method Description
      static org.apache.commons.configuration.PropertiesConfiguration fromFile​(File file)
      Instantiate a PropertiesConfiguration from a File.
      static org.apache.commons.configuration.PropertiesConfiguration fromInputStream​(InputStream inputStream)
      Instantiate a PropertiesConfiguration from an inputstream.
      static List<String> getKeys​(org.apache.commons.configuration.Configuration configuration)
      Provides a list of all the keys found in a Configuration.
      static Stream<String> getKeysStream​(org.apache.commons.configuration.Configuration configuration)
      Provides a stream of all the keys found in a Configuration.
      static void saveToFile​(org.apache.commons.configuration.PropertiesConfiguration propertiesConfiguration, File file)  
      static Map<String,​Object> toMap​(org.apache.commons.configuration.Configuration configuration)  

    • Constructor Detail

      • CommonsConfigurationUtils

        public CommonsConfigurationUtils()

    • Method Detail

      • fromFile

        public static org.apache.commons.configuration.PropertiesConfiguration fromFile​(File file)
        Instantiate a PropertiesConfiguration from a File.
        Parameters:
        file - containing properties
        Returns:
        a PropertiesConfiguration instance. Empty if file does not exist.

      • fromInputStream

        public static org.apache.commons.configuration.PropertiesConfiguration fromInputStream​(InputStream inputStream)
        Instantiate a PropertiesConfiguration from an inputstream.
        Parameters:
        inputStream - containing properties
        Returns:
        a PropertiesConfiguration instance.

      • saveToFile

        public static void saveToFile​(org.apache.commons.configuration.PropertiesConfiguration propertiesConfiguration,
                              File file)

      • getKeysStream

        public static Stream<String> getKeysStream​(org.apache.commons.configuration.Configuration configuration)
        Provides a stream of all the keys found in a Configuration.
        Parameters:
        configuration - to iterate on keys
        Returns:
        a stream of keys

      • getKeys

        public static List<String> getKeys​(org.apache.commons.configuration.Configuration configuration)
        Provides a list of all the keys found in a Configuration.
        Parameters:
        configuration - to iterate on keys
        Returns:
        a list of keys

      • toMap

        public static Map<String,​Object> toMap​(org.apache.commons.configuration.Configuration configuration)
        Returns:
        a key-value Map found in the provided Configuration