Language

TreeSet Class

Definition

A NavigableSet implementation based on a TreeMap.

[Android.Runtime.Register("java/util/TreeSet", DoNotGenerateAcw=true)]
[Java.Interop.JavaTypeParameters(new System.String[] { "E" })]
public class TreeSet : Java.Util.AbstractSet, IDisposable, Java.IO.ISerializable, Java.Lang.ICloneable, Java.Util.INavigableSet
[<Android.Runtime.Register("java/util/TreeSet", DoNotGenerateAcw=true)>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "E" })>]
type TreeSet = class
    inherit AbstractSet
    interface ISerializable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface ICloneable
    interface INavigableSet
    interface ISortedSet
    interface ISequencedSet
    interface ISequencedCollection
    interface ICollection
    interface IIterable
    interface ISet
Inheritance
Attributes
Implements

Remarks

A NavigableSet implementation based on a TreeMap. The elements are ordered using their Comparable natural ordering, or by a Comparator provided at set creation time, depending on which constructor is used.

This implementation provides guaranteed log(n) time cost for the basic operations (add, remove and contains).

Note that the ordering maintained by a set (whether or not an explicit comparator is provided) must be consistent with equals if it is to correctly implement the Set interface. (See Comparable or Comparator for a precise definition of consistent with equals.) This is so because the Set interface is defined in terms of the equals operation, but a TreeSet instance performs all element comparisons using its compareTo (or compare) method, so two elements that are deemed equal by this method are, from the standpoint of the set, equal. The behavior of a set is well-defined even if its ordering is inconsistent with equals; it just fails to obey the general contract of the Set interface.

<strong>Note that this implementation is not synchronized.</strong> If multiple threads access a tree set concurrently, and at least one of the threads modifies the set, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the set. If no such object exists, the set should be "wrapped" using the Collections#synchronizedSortedSet Collections.synchronizedSortedSet method. This is best done at creation time, to prevent accidental unsynchronized access to the set:

SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...));

The iterators returned by this class's iterator method are fail-fast: if the set is modified at any time after the iterator is created, in any way except through the iterator's own remove method, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

The #addFirst addFirst and #addLast addLast methods of this class throw UnsupportedOperationException. The encounter order of elements is determined by the comparison method; therefore, explicit positioning is not supported.

This class is a member of the Java Collections Framework.

Added in 1.2.

Java documentation for java.util.TreeSet.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name Description
TreeSet()

Constructs a new, empty tree set, sorted according to the natural ordering of its elements.

TreeSet(ICollection)

Constructs a new tree set containing the elements in the specified collection, sorted according to the natural ordering of its elements.

TreeSet(IComparator)

Constructs a new, empty tree set, sorted according to the specified comparator.

TreeSet(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

TreeSet(ISortedSet)

Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set.

Properties

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
IsEmpty

Returns true if this collection contains no elements.

(Inherited from AbstractCollection)
JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState

Gets the state flags last assigned by the runtime.

(Inherited from JavaObject)
JniPeerMembers

Gets the JNI metadata used to access members of this Java binding.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Name Description
Add(Object)

Ensures that this collection contains the specified element (optional operation).

(Inherited from AbstractCollection)
AddAll(ICollection)

Adds all of the elements in the specified collection to this collection (optional operation).

(Inherited from AbstractCollection)
AddFirst(Object)

Throws UnsupportedOperationException.

AddLast(Object)

Throws UnsupportedOperationException.

Ceiling(Object)

Added in 1.

Clear()

Removes all of the elements from this collection (optional operation).

(Inherited from AbstractCollection)
Clone()

Returns a shallow copy of this TreeSet instance.

Comparator()

Returns the comparator used to compare elements in this TreeSet.

Construct(JniObjectReference, JniObjectReferenceOptions)

Delegates construction of this peer to the runtime's value manager.

(Inherited from JavaObject)
Contains(Object)

Returns true if this collection contains the specified element.

(Inherited from AbstractCollection)
ContainsAll(ICollection)

Returns true if this collection contains all of the elements in the specified collection.

(Inherited from AbstractCollection)
DescendingIterator()

Returns an iterator over the elements in this set in descending order.

DescendingSet()

Returns a reverse order view of the elements contained in this set.

Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced()

Asks the value manager to dispose this peer unless its mapping retains this same managed instance.

(Inherited from JavaObject)
Equals(Object)

Tests whether another managed peer refers to the same Java object.

(Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
First()

Returns the first element in this set.

Floor(Object)

Added in 1.

GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
HeadSet(Object, Boolean)

Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement.

HeadSet(Object)

Returns a view of the portion of this set whose elements are strictly less than toElement.

Higher(Object)

Added in 1.

Iterator()

Returns an iterator over the elements in this set in ascending order.

JavaFinalize()
Obsolete.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Last()

Returns the last element in this set.

Lower(Object)

Added in 1.

Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
PollFirst()

Added in 1.

PollLast()

Added in 1.

Remove(Object)

Removes a single instance of the specified element from this collection, if it is present (optional operation).

(Inherited from AbstractCollection)
RemoveAll(ICollection)

Removes all of this collection's elements that are also contained in the specified collection (optional operation).

(Inherited from AbstractCollection)
RetainAll(ICollection)

Retains only the elements in this collection that are contained in the specified collection (optional operation).

(Inherited from AbstractCollection)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Stores a reference value in the control block without creating a JNI reference copy.

(Inherited from JavaObject)
Size()

Returns the number of elements in this set (its cardinality).

Spliterator()

Creates a <em>"Spliterator.

SubSet(Object, Boolean, Object, Boolean)

Returns a view of the portion of this set whose elements range from fromElement to toElement.

SubSet(Object, Object)

Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.

TailSet(Object, Boolean)

Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement.

TailSet(Object)

Returns a view of the portion of this set whose elements are greater than or equal to fromElement.

ToArray()

Returns an array containing all of the elements in this collection.

(Inherited from AbstractCollection)
ToArray(Object[])

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

(Inherited from AbstractCollection)
ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed()

Marks this peer as disposed and calls Dispose with disposing set to true.

(Inherited from JavaObject)
IJavaPeerable.Finalized()

Marks this peer as disposed and calls Dispose with disposing set to false.

(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Gets the native control-block pointer used by this peer.

(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Stores the identity hash code supplied by the runtime.

(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Replaces the stored managed peer state flags.

(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Updates the peer reference and releases a disposed peer's control block when the reference is invalid.

(Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Removes this instance from the runtime's Java object lookup.

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)

Reuses a compatible managed peer or obtains a wrapper of the requested type.

ToEnumerable(IIterable)

Returns an IEnumerable that iterates over a Java IIterable, allowing foreach and LINQ to be used with Java collection types. Each element is marshaled from its Java instance to the corresponding managed type.

ToEnumerable<T>(IIterable)

Returns an IEnumerable<T> that iterates over a Java IIterable, marshaling each element to T. This allows foreach and LINQ to be used with Java collection types.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to