Package org.spongepowered.configurate.util

Class UnmodifiableCollections

java.lang.Object
org.spongepowered.configurate.util.UnmodifiableCollections
public final class UnmodifiableCollections extends Object
Provides a set of methods that produce unmodifiable copies of collections.
Since:
4.0.0

  • Method Details

    • copyOf

      public static <E> List<E> copyOf(List<E> original)
      Creates an unmodifiable copy of the given List instance.
      Type Parameters:
      E - the type of every item in the entry
      Parameters:
      original - the list to be copied
      Returns:
      a unmodifiable copy of the given List instance
      Since:
      4.0.0

    • copyOf

      public static <E> Set<E> copyOf(Set<E> original)
      Creates an unmodifiable copy of the given Set instance.
      Type Parameters:
      E - the type of every item in the entry
      Parameters:
      original - the set to be copied
      Returns:
      a unmodifiable copy of the given Set instance
      Since:
      4.0.0

    • copyOf

      public static <K, V> Map<K,V> copyOf(Map<K,V> original)
      Creates an unmodifiable copy of the given Map instance.
      Type Parameters:
      K - key type of the map
      V - value type of the map
      Parameters:
      original - the map to be copied
      Returns:
      an unmodifiable copy of the given Map instance.
      Since:
      4.1.0

    • toList

      @SafeVarargs public static <E> List<E> toList(E... original)
      Creates an unmodifiable copy of the given array as a list, preserving order.
      Type Parameters:
      E - the type of every item in the entry
      Parameters:
      original - the array to be copied into a list
      Returns:
      a unmodifiable copy of the given array as a List instance
      Since:
      4.0.0

    • toSet

      @SafeVarargs public static <E> Set<E> toSet(E... original)
      Creates an unmodifiable copy of the given array as a set.
      Type Parameters:
      E - the type of every item in the entry
      Parameters:
      original - the array to be copied into a set
      Returns:
      a unmodifiable copy of the given array as a Set instance
      Since:
      4.0.0

    • buildMap

      public static <K, V> Map<K,V> buildMap(Consumer<Map<K,V>> handler)
      Build an unmodifiable map.
      Type Parameters:
      K - key type
      V - value type
      Parameters:
      handler - consumer that will populate the map wih keys
      Returns:
      a new unmodifiable map
      Since:
      4.0.0

    • immutableMapEntry

      public static <K, V> Map.Entry<K,V> immutableMapEntry(K key, V value)
      Creates an immutable instance of Map.Entry.
      Type Parameters:
      K - the key's type
      V - the value's type
      Parameters:
      key - the key in the entry
      value - the value in the entry
      Returns:
      the new map entry
      Since:
      4.0.0