Interface ValueMap

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static ValueMap EMPTY
      Empty immutable value map.
    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default <T> T get​(@NotNull java.lang.String name, @NotNull java.lang.Class<T> type)
      Get a named property and convert it into the given type.
      default <T> T get​(@NotNull java.lang.String name, T defaultValue)
      Get a named property and convert it into the given type.
      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
    • Field Detail

      • EMPTY

        static final ValueMap EMPTY
        Empty immutable value map.
    • Method Detail

      • get

        @Nullable
        default <T> T get​(@NotNull
                          @NotNull java.lang.String name,
                          @NotNull
                          @NotNull java.lang.Class<T> type)
        Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return null in this case.
        Type Parameters:
        T - The class of the type
        Parameters:
        name - The name of the property
        type - The class of the type
        Returns:
        Return named value converted to type T or null if non existing or can't be converted.
      • get

        @NotNull
        default <T> T get​(@NotNull
                          @NotNull java.lang.String name,
                          @NotNull
                          T defaultValue)
        Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return the default value in this case.

        Implementation hint: In the past it was allowed to call this with a 2nd parameter being null. Therefore all implementations should internally call Map.get(Object) when the 2nd parameter has value null.
        Type Parameters:
        T - The expected type
        Parameters:
        name - The name of the property
        defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. Must not be null. If you want to return null by default rather rely on get(String, Class).
        Returns:
        Return named value converted to type T or the default value if non existing or can't be converted.