Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

TreeSet

extends AbstractSet<E>
implements Serializable Cloneable SortedSet<E>

java.lang.Object
↳	java.util.AbstractCollection<E>
	↳	java.util.AbstractSet<E>
		↳	java.util.TreeSet<E>

Class Overview

TreeSet is an implementation of SortedSet. All optional operations are supported, adding and removing. The elements can be any objects which are comparable to each other either using their natural order or a specified Comparator.

Summary

Public Constructors
	TreeSet() Constructs a new empty instance of TreeSet which uses natural ordering.
	TreeSet(Collection<? extends E> collection) Constructs a new instance of TreeSet which uses natural ordering and containing the unique elements in the specified collection.
	TreeSet(Comparator<? super E> comparator) Constructs a new empty instance of TreeSet which uses the specified Comparator.
	TreeSet(SortedSet<E> set) Constructs a new instance of TreeSet containing the elements in the specified SortedSet and using the same Comparator.

Public Methods
boolean	add(E object) Adds the specified object to this TreeSet.
boolean	addAll(Collection<? extends E> collection) Adds the objects in the specified Collection to this TreeSet.
void	clear() Removes all elements from this TreeSet, leaving it empty.
Object	clone() Returns a new TreeSet with the same elements, size and comparator as this TreeSet.
Comparator<? super E>	comparator() Returns the Comparator used to compare elements in this TreeSet.
boolean	contains(Object object) Searches this TreeSet for the specified object.
E	first() Returns the first element in this TreeSet.
SortedSet<E>	headSet(E end) Returns a SortedSet of the specified portion of this TreeSet which contains elements less than the end element.
boolean	isEmpty() Returns if this TreeSet has no elements, a size of zero.
Iterator<E>	iterator() Returns an Iterator on the elements of this TreeSet.
E	last() Returns the last element in this TreeSet.
boolean	remove(Object object) Removes an occurrence of the specified object from this TreeSet.
int	size() Returns the number of elements in this TreeSet.
SortedSet<E>	subSet(E start, E end) Returns a SortedSet of the specified portion of this TreeSet which contains elements greater or equal to the start element but less than the end element.
SortedSet<E>	tailSet(E start) Returns a SortedSet of the specified portion of this TreeSet which contains elements greater or equal to the start element.

[Expand]

Inherited Methods

From class java.util.AbstractSet

From class java.util.AbstractCollection

boolean	add(E object) If the specified element is not contained within this collection, and addition of this element succeeds, then true will be returned.
boolean	addAll(Collection<? extends E> collection) Adds the objects in the specified Collection to this Collection.
void	clear() Removes all the elements in this collection.
boolean	contains(Object object) Searches this Collection for the specified object.
boolean	containsAll(Collection<?> collection) Searches this Collection for all objects in the specified Collection.
boolean	isEmpty() Returns true if the collection has no element, otherwise false.
abstract Iterator<E>	iterator() Returns an Iterator on the elements of this Collection.
boolean	remove(Object object) Removes the first occurrence of the specified object from this Collection.
boolean	removeAll(Collection<?> collection) Removes all occurrences in this Collection of each object in the specified Collection.
boolean	retainAll(Collection<?> collection) Removes all objects from this Collection that are not contained in the specified Collection.
abstract int	size() Returns the number of elements in this Collection.
<T> T[]	toArray(T[] contents) Returns an array containing all elements contained in this Collection.
Object[]	toArray() Returns a new array containing all elements contained in this Collection.
String	toString() Returns the string representation of this Collection.

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

From interface java.lang.Iterable

From interface java.util.Collection

abstract boolean	add(E object) Attempts to add `object` to the contents of this `Collection`.
abstract boolean	addAll(Collection<? extends E> collection) Attempts to add all of the objects contained in `collection` to the contents of this collection.
abstract void	clear() Removes all elements from this Collection, leaving it empty.
abstract boolean	contains(Object object) Searches this Collection for the specified object.
abstract boolean	containsAll(Collection<?> collection) Searches this Collection for all objects in the specified Collection.
abstract boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
abstract int	hashCode() Returns an integer hash code for the receiver.
abstract boolean	isEmpty() Returns if this Collection has no elements, a size of zero.
abstract Iterator<E>	iterator() Returns an instance of Iterator that may be used to access the objects contained by this collection.
abstract boolean	remove(Object object) Removes the first occurrence of the specified object from this Collection.
abstract boolean	removeAll(Collection<?> collection) Removes all occurrences in this Collection of each object in the specified Collection.
abstract boolean	retainAll(Collection<?> collection) Removes all objects from this Collection that are not also found in the contents of `collection`.
abstract int	size() Returns a count of how many objects are contained by this collection.
abstract <T> T[]	toArray(T[] array) Returns an array containing all elements contained in this Collection.
abstract Object[]	toArray() Returns a new array containing all elements contained in this Collection.

From interface java.util.Set

abstract boolean	add(E object) Adds the specified object to this Set.
abstract boolean	addAll(Collection<? extends E> collection) Adds the objects in the specified Collection which do not exist in this Set.
abstract void	clear() Removes all elements from this Set, leaving it empty.
abstract boolean	contains(Object object) Searches this Set for the specified object.
abstract boolean	containsAll(Collection<?> collection) Searches this Set for all objects in the specified Collection.
abstract boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
abstract int	hashCode() Returns an integer hash code for the receiver.
abstract boolean	isEmpty() Returns if this Set has no elements, a size of zero.
abstract Iterator<E>	iterator() Returns an Iterator on the elements of this Set.
abstract boolean	remove(Object object) Removes any occurrence of the specified object from this Set.
abstract boolean	removeAll(Collection<?> collection) Removes all objects in the specified Collection from this Set.
abstract boolean	retainAll(Collection<?> collection) Removes all objects from this Set that are not contained in the specified Collection.
abstract int	size() Returns the number of elements in this Set.
abstract <T> T[]	toArray(T[] array) Returns an array containing all elements contained in this Set.
abstract Object[]	toArray() Returns an array containing all elements contained in this Set.

From interface java.util.SortedSet

Public Constructors

public TreeSet ()

Constructs a new empty instance of TreeSet which uses natural ordering.

public TreeSet (Collection<? extends E> collection)

Constructs a new instance of TreeSet which uses natural ordering and containing the unique elements in the specified collection.

Parameters

collection	the collection of elements to add

Throws

ClassCastException	when an element in the Collection does not implement the Comparable interface, or the elements in the Collection cannot be compared

public TreeSet (Comparator<? super E> comparator)

Constructs a new empty instance of TreeSet which uses the specified Comparator.

Parameters

comparator	the Comparator

public TreeSet (SortedSet<E> set)

Constructs a new instance of TreeSet containing the elements in the specified SortedSet and using the same Comparator.

Parameters

set	the SortedSet of elements to add

Public Methods

public boolean add (E object)

Adds the specified object to this TreeSet.

Parameters

object	the object to add

Returns

true when this TreeSet did not already contain the object, false otherwise

Throws

ClassCastException	when the object cannot be compared with the elements in this TreeSet
NullPointerException	when the object is null and the comparator cannot handle null

public boolean addAll (Collection<? extends E> collection)

Adds the objects in the specified Collection to this TreeSet.

Parameters

collection	the Collection of objects

Returns

true if this TreeSet is modified, false otherwise

Throws

ClassCastException	when an object in the Collection cannot be compared with the elements in this TreeSet
NullPointerException	when an object in the Collection is null and the comparator cannot handle null

public void clear ()

Removes all elements from this TreeSet, leaving it empty.

public Object clone ()

Returns a new TreeSet with the same elements, size and comparator as this TreeSet.

Returns

a shallow copy of this TreeSet

public Comparator<? super E> comparator ()

Returns the Comparator used to compare elements in this TreeSet.

Returns

a Comparator or null if the natural ordering is used

public boolean contains (Object object)

Searches this TreeSet for the specified object.

Parameters

object	the object to search for

Returns

true if object is an element of this TreeSet, false otherwise

Throws

ClassCastException	when the object cannot be compared with the elements in this TreeSet
NullPointerException	when the object is null and the comparator cannot handle null

public E first ()

Returns the first element in this TreeSet.

Returns

the first element

Throws

NoSuchElementException	when this TreeSet is empty

public SortedSet<E> headSet (E end)

Returns a SortedSet of the specified portion of this TreeSet which contains elements less than the end element. The returned SortedSet is backed by this TreeSet so changes to one are reflected by the other.

Parameters

end	the end element

Returns

a subset where the elements are less than end

Throws

ClassCastException	when the end object cannot be compared with the elements in this TreeSet
NullPointerException	when the end object is null and the comparator cannot handle null

public boolean isEmpty ()

Returns if this TreeSet has no elements, a size of zero.

Returns

true if this TreeSet has no elements, false otherwise

public Iterator<E> iterator ()

Returns an Iterator on the elements of this TreeSet.

Returns

an Iterator on the elements of this TreeSet

public E last ()

Returns the last element in this TreeSet.

Returns

the last element

Throws

NoSuchElementException	when this TreeSet is empty

public boolean remove (Object object)

Removes an occurrence of the specified object from this TreeSet.

Parameters

object	the object to remove

Returns

true if this TreeSet is modified, false otherwise

Throws

ClassCastException	when the object cannot be compared with the elements in this TreeSet
NullPointerException	when the object is null and the comparator cannot handle null

public int size ()

Returns the number of elements in this TreeSet.

Returns

the number of elements in this TreeSet

public SortedSet<E> subSet (E start, E end)

Returns a SortedSet of the specified portion of this TreeSet which contains elements greater or equal to the start element but less than the end element. The returned SortedSet is backed by this TreeSet so changes to one are reflected by the other.

Parameters

start	the start element
end	the end element

Returns

a subset where the elements are greater or equal to start and less than end

Throws

ClassCastException	when the start or end object cannot be compared with the elements in this TreeSet
NullPointerException	when the start or end object is null and the comparator cannot handle null

public SortedSet<E> tailSet (E start)

Returns a SortedSet of the specified portion of this TreeSet which contains elements greater or equal to the start element. The returned SortedSet is backed by this TreeSet so changes to one are reflected by the other.

Parameters

start	the start element

Returns

a subset where the elements are greater or equal to start

Throws

ClassCastException	when the start object cannot be compared with the elements in this TreeSet
NullPointerException	when the start object is null and the comparator cannot handle null

Jan	FEB	Mar
	18
2008	2009	2010

Interfaces

Classes

Enums

Exceptions

TreeSet

Class Overview

Summary

Public Constructors

public TreeSet ()

public TreeSet (Collection<? extends E> collection)

Parameters

Throws

public TreeSet (Comparator<? super E> comparator)

Parameters

public TreeSet (SortedSet<E> set)

Parameters

Public Methods

public boolean add (E object)

Parameters

Returns

Throws

public boolean addAll (Collection<? extends E> collection)

Parameters

Returns

Throws

public void clear ()

See Also

public Object clone ()

Returns

See Also

public Comparator<? super E> comparator ()

Returns

public boolean contains (Object object)

Parameters

Returns

Throws

public E first ()

Returns

Throws

public SortedSet<E> headSet (E end)

Parameters

Returns

Throws

public boolean isEmpty ()

Returns

See Also

public Iterator<E> iterator ()

Returns

See Also

public E last ()

Returns

Throws

public boolean remove (Object object)

Parameters

Returns

Throws

public int size ()

Returns

public SortedSet<E> subSet (E start, E end)

Parameters

Returns

Throws

public SortedSet<E> tailSet (E start)

Parameters

Returns

Throws