com.github.andrewoma.dexx.collection
Interface SortedSet<E>

All Superinterfaces:

Iterable<E>, Set<E>, Traversable<E>

All Known Implementing Classes:

AbstractSortedSet, TreeSet

public interface SortedSet<E>
extends Set<E>

SortedSet defines the interface for sets that are sorted.

Method Summary

SortedSet<E>	add(E value) Returns a set that adds the specified value if it doesn't already exist in this set.
SortedSet<E>	asSortedSet() Returns an immutable view of this set as an instance of java.util.SortedSet.
Comparator<? super E>	comparator() Returns the comparator associated with this map, or null if the default ordering is used.
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.
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.
SortedSet<E>	range(E from, boolean fromInclusive, E to, boolean toInclusive) Returns a subset of the set between the from and to keys specified.
SortedSet<E>	remove(E value) Removes the specified value from the set if it exists.
SortedSet<E>	take(int number) Returns a set containing the first number of elements from this set.
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.Set

asSet, contains

Methods inherited from interface com.github.andrewoma.dexx.collection.Iterable

iterator

Methods inherited from interface com.github.andrewoma.dexx.collection.Traversable

forEach, isEmpty, makeString, makeString, size, to, toArray, toArray, toIndexedList, toSet, toSortedSet

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
SortedSet<E> drop(int number)

Returns a set containing all elements in this set, excluding the first number of elements.

take

@NotNull
SortedSet<E> take(int number)

Returns a set containing the first number of elements from this set.

add

@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
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

Comparator<? super E> comparator()

Returns the comparator associated with this map, or null if the default ordering is used.

from

@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
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
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
SortedSet<E> asSortedSet()

Returns an immutable view of this set as an instance of java.util.SortedSet.