Package org.eclipse.aether.util

Class ConfigUtils

  • public final class ConfigUtils
extends java.lang.Object
    A utility class to read configuration properties from a repository system session.
    See Also:
    RepositorySystemSession.getConfigProperties()

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean getBoolean​(java.util.Map<?,​?> properties, boolean defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static boolean getBoolean​(org.eclipse.aether.RepositorySystemSession session, boolean defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static float getFloat​(java.util.Map<?,​?> properties, float defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static float getFloat​(org.eclipse.aether.RepositorySystemSession session, float defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static int getInteger​(java.util.Map<?,​?> properties, int defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static int getInteger​(org.eclipse.aether.RepositorySystemSession session, int defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.util.List<?> getList​(java.util.Map<?,​?> properties, java.util.List<?> defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.util.List<?> getList​(org.eclipse.aether.RepositorySystemSession session, java.util.List<?> defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static long getLong​(java.util.Map<?,​?> properties, long defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static long getLong​(org.eclipse.aether.RepositorySystemSession session, long defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.util.Map<?,​?> getMap​(java.util.Map<?,​?> properties, java.util.Map<?,​?> defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.util.Map<?,​?> getMap​(org.eclipse.aether.RepositorySystemSession session, java.util.Map<?,​?> defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.lang.Object getObject​(java.util.Map<?,​?> properties, java.lang.Object defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.lang.Object getObject​(org.eclipse.aether.RepositorySystemSession session, java.lang.Object defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.lang.String getString​(java.util.Map<?,​?> properties, java.lang.String defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.lang.String getString​(org.eclipse.aether.RepositorySystemSession session, java.lang.String defaultValue, java.lang.String... keys)
      Gets the specified configuration property.
      static java.util.List<java.lang.String> parseCommaSeparatedNames​(java.lang.String commaSeparatedNames)
      Utility method to parse configuration string that contains comma separated list of names into List<String>, never returns null.
      static java.util.List<java.lang.String> parseCommaSeparatedUniqueNames​(java.lang.String commaSeparatedNames)
      Utility method to parse configuration string that contains comma separated list of names into List<String> with unique elements (duplicates, if any, are discarded), never returns null.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getObject

        public static java.lang.Object getObject​(java.util.Map<?,​?> properties,
                                         java.lang.Object defaultValue,
                                         java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys are set, may be null
        keys - the property keys to read, must not be null. The specified keys are read one after one until a valid value is found.
        Returns:
        the property value or null if none

      • getObject

        public static java.lang.Object getObject​(org.eclipse.aether.RepositorySystemSession session,
                                         java.lang.Object defaultValue,
                                         java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys are set, may be null
        keys - the property keys to read, must not be null. The specified keys are read one after one until a valid value is found.
        Returns:
        the property value or null if none

      • getString

        public static java.lang.String getString​(java.util.Map<?,​?> properties,
                                         java.lang.String defaultValue,
                                         java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a string, may be null
        keys - the property keys to read, must not be null. The specified keys are read one after one until a string value is found.
        Returns:
        the property value or null if none

      • getString

        public static java.lang.String getString​(org.eclipse.aether.RepositorySystemSession session,
                                         java.lang.String defaultValue,
                                         java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a string, may be null
        keys - the property keys to read, must not be null. The specified keys are read one after one until a string value is found.
        Returns:
        the property value or null if none

      • getInteger

        public static int getInteger​(java.util.Map<?,​?> properties,
                             int defaultValue,
                             java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a number
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Number or a string representation of an Integer is found.
        Returns:
        the property value

      • getInteger

        public static int getInteger​(org.eclipse.aether.RepositorySystemSession session,
                             int defaultValue,
                             java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a number
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Number or a string representation of an Integer is found.
        Returns:
        the property value

      • getLong

        public static long getLong​(java.util.Map<?,​?> properties,
                           long defaultValue,
                           java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a number
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Number or a string representation of a Long is found.
        Returns:
        the property value

      • getLong

        public static long getLong​(org.eclipse.aether.RepositorySystemSession session,
                           long defaultValue,
                           java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a number
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Number or a string representation of a Long is found.
        Returns:
        the property value

      • getFloat

        public static float getFloat​(java.util.Map<?,​?> properties,
                             float defaultValue,
                             java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a number
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Number or a string representation of a Float is found.
        Returns:
        the property value

      • getFloat

        public static float getFloat​(org.eclipse.aether.RepositorySystemSession session,
                             float defaultValue,
                             java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a number
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Number or a string representation of a Float is found.
        Returns:
        the property value

      • getBoolean

        public static boolean getBoolean​(java.util.Map<?,​?> properties,
                                 boolean defaultValue,
                                 java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a boolean
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Boolean or a string (to be parsed as boolean) is found.
        Returns:
        the property value

      • getBoolean

        public static boolean getBoolean​(org.eclipse.aether.RepositorySystemSession session,
                                 boolean defaultValue,
                                 java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a boolean
        keys - the property keys to read, must not be null. The specified keys are read one after one until a Boolean or a string (to be parsed as boolean) is found.
        Returns:
        the property value

      • getList

        public static java.util.List<?> getList​(java.util.Map<?,​?> properties,
                                        java.util.List<?> defaultValue,
                                        java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a collection
        keys - the property keys to read, must not be null. The specified keys are read one after one until a collection is found.
        Returns:
        the property value or null if none

      • getList

        public static java.util.List<?> getList​(org.eclipse.aether.RepositorySystemSession session,
                                        java.util.List<?> defaultValue,
                                        java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a collection
        keys - the property keys to read, must not be null. The specified keys are read one after one until a collection is found.
        Returns:
        the property value or null if none

      • getMap

        public static java.util.Map<?,​?> getMap​(java.util.Map<?,​?> properties,
                                              java.util.Map<?,​?> defaultValue,
                                              java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        properties - the configuration properties to read, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a map
        keys - the property keys to read, must not be null. The specified keys are read one after one until a map is found.
        Returns:
        the property value or null if none

      • getMap

        public static java.util.Map<?,​?> getMap​(org.eclipse.aether.RepositorySystemSession session,
                                              java.util.Map<?,​?> defaultValue,
                                              java.lang.String... keys)
        Gets the specified configuration property.
        Parameters:
        session - the repository system session from which to read the configuration property, must not be null
        defaultValue - the default value to return in case none of the property keys is set to a map
        keys - the property keys to read, must not be null. The specified keys are read one after one until a map is found.
        Returns:
        the property value or null if none

      • parseCommaSeparatedNames

        public static java.util.List<java.lang.String> parseCommaSeparatedNames​(java.lang.String commaSeparatedNames)
        Utility method to parse configuration string that contains comma separated list of names into List<String>, never returns null.
        Since:
        1.9.0

      • parseCommaSeparatedUniqueNames

        public static java.util.List<java.lang.String> parseCommaSeparatedUniqueNames​(java.lang.String commaSeparatedNames)
        Utility method to parse configuration string that contains comma separated list of names into List<String> with unique elements (duplicates, if any, are discarded), never returns null.
        Since:
        1.9.0