Interface SortedSet<E>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull SortedSet<E> add​(E value)
      Returns a set that adds the specified value if it doesn't already exist in this set.
      java.util.SortedSet<E> asSortedSet()
      Returns an immutable view of this set as an instance of java.util.SortedSet.
      java.util.Comparator<? super E> comparator()
      Returns the comparator associated with this map, or null if the default ordering is used.
      @NotNull SortedSet<E> drop​(int number)
      Returns a set containing all elements in this set, excluding the first number of elements.
      E first()
      Returns the first element in the set or null of the set is empty.
      @NotNull SortedSet<E> from​(E value, boolean inclusive)
      Returns the bottom of the set starting from the key specified.
      E last()
      Returns the last element in the set or null of the set is empty.
      @NotNull SortedSet<E> range​(E from, boolean fromInclusive, E to, boolean toInclusive)
      Returns a subset of the set between the from and to keys specified.
      @NotNull SortedSet<E> remove​(E value)
      Removes the specified value from the set if it exists.
      @NotNull SortedSet<E> take​(int number)
      Returns a set containing the first number of elements from this set.
      @NotNull SortedSet<E> to​(E value, boolean inclusive)
      Returns the top of the set up until the key specified.
      • Methods inherited from interface com.github.andrewoma.dexx.collection.Iterable

        iterator
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
      • Methods inherited from interface com.github.andrewoma.dexx.collection.Set

        asSet, contains
    • Method Detail

      • first

        @Nullable
        E first()
        Returns the first element in the set or null of the set is empty.
      • last

        @Nullable
        E last()
        Returns the last element in the set or null of the set is empty.
      • drop

        @NotNull
        @NotNull SortedSet<E> drop​(int number)
        Returns a set containing all elements in this set, excluding the first number of elements.
      • take

        @NotNull
        @NotNull SortedSet<E> take​(int number)
        Returns a set containing the first number of elements from this set.
      • add

        @NotNull
        @NotNull SortedSet<E> add​(E value)
        Description copied from interface: Set
        Returns a set that adds the specified value if it doesn't already exist in this set.
        Specified by:
        add in interface Set<E>
      • remove

        @NotNull
        @NotNull SortedSet<E> remove​(E value)
        Description copied from interface: Set
        Removes the specified value from the set if it exists.
        Specified by:
        remove in interface Set<E>
      • comparator

        java.util.Comparator<? super E> comparator()
        Returns the comparator associated with this map, or null if the default ordering is used.
      • from

        @NotNull
        @NotNull SortedSet<E> from​(@NotNull
                                   E value,
                                   boolean inclusive)
        Returns the bottom of the set starting from the key specified.
        Parameters:
        inclusive - if true, the key will be included in the result, otherwise it will be excluded
      • to

        @NotNull
        @NotNull SortedSet<E> to​(@NotNull
                                 E value,
                                 boolean inclusive)
        Returns the top of the set up until the key specified.
        Parameters:
        inclusive - if true, the key will be included in the result, otherwise it will be excluded
      • range

        @NotNull
        @NotNull SortedSet<E> range​(@NotNull
                                    E from,
                                    boolean fromInclusive,
                                    @NotNull
                                    E to,
                                    boolean toInclusive)
        Returns a subset of the set between the from and to keys specified.
        Parameters:
        fromInclusive - if true, the key will be included in the result, otherwise it will be excluded
        toInclusive - if true, the key will be included in the result, otherwise it will be excluded
      • asSortedSet

        @NotNull
        java.util.SortedSet<E> asSortedSet()
        Returns an immutable view of this set as an instance of java.util.SortedSet.