ISortedSet Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Set that further provides a total ordering on its elements.
[Android.Runtime.Register("java/util/SortedSet", "", "Java.Util.ISortedSetInvoker")]
[Java.Interop.JavaTypeParameters(new System.String[] { "E" })]
public interface ISortedSet : IDisposable, Java.Interop.IJavaPeerable, Java.Util.ISet[<Android.Runtime.Register("java/util/SortedSet", "", "Java.Util.ISortedSetInvoker")>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "E" })>]
type ISortedSet = interface
interface ISet
interface ICollection
interface IIterable
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Derived
- Attributes
- Implements
Remarks
A Set that further provides a total ordering on its elements. The elements are ordered using their Comparable natural ordering, or by a Comparator typically provided at sorted set creation time. The set's iterator will traverse the set in ascending element order. Several additional operations are provided to take advantage of the ordering. (This interface is the set analogue of SortedMap.)
All elements inserted into a sorted set must implement the Comparable interface (or be accepted by the specified comparator). Furthermore, all such elements must be mutually comparable: e1.compareTo(e2) (or comparator.compare(e1, e2)) must not throw a ClassCastException for any elements e1 and e2 in the sorted set. Attempts to violate this restriction will cause the offending method or constructor invocation to throw a ClassCastException.
Note that the ordering maintained by a sorted set (whether or not an explicit comparator is provided) must be consistent with equals if the sorted set is to correctly implement the Set interface. (See the Comparable interface or Comparator interface 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 sorted set 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 sorted set, equal. The behavior of a sorted set is well-defined even if its ordering is inconsistent with equals; it just fails to obey the general contract of the Set interface.
All general-purpose sorted set implementation classes should provide four "standard" constructors: 1) A void (no arguments) constructor, which creates an empty sorted set sorted according to the natural ordering of its elements. 2) A constructor with a single argument of type Comparator, which creates an empty sorted set sorted according to the specified comparator. 3) A constructor with a single argument of type Collection, which creates a new sorted set with the same elements as its argument, sorted according to the natural ordering of the elements. 4) A constructor with a single argument of type SortedSet, which creates a new sorted set with the same elements and the same ordering as the input sorted set. There is no way to enforce this recommendation, as interfaces cannot contain constructors.
Note: several methods return subsets with restricted ranges. Such ranges are half-open, that is, they include their low endpoint but not their high endpoint (where applicable). If you need a closed range (which includes both endpoints), and the element type allows for calculation of the successor of a given value, merely request the subrange from lowEndpoint to successor(highEndpoint). For example, suppose that s is a sorted set of strings. The following idiom obtains a view containing all of the strings in s from low to high, inclusive:
SortedSet<String> sub = s.subSet(low, high+"\0");
A similar technique can be used to generate an open range (which contains neither endpoint). The following idiom obtains a view containing all of the Strings in s from low to high, exclusive:
SortedSet<String> sub = s.subSet(low+"\0", high);
This interface is a member of the Java Collections Framework.
Added in 1.2.
Java documentation for java.util.SortedSet.
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.
Properties
| Handle |
Gets the JNI value of the underlying Android object. (Inherited from IJavaObject) |
| IsEmpty |
Returns true if this set has no elements. (Inherited from ISet) |
| JniIdentityHashCode |
Returns the value of |
| JniManagedPeerState |
State of the managed peer. (Inherited from IJavaPeerable) |
| JniPeerMembers |
Member access and invocation support. (Inherited from IJavaPeerable) |
| PeerReference |
Returns a JniObjectReference of the wrapped Java object instance. (Inherited from IJavaPeerable) |
Methods
| Add(Object) |
Adds the specified element to this set if it is not already present (optional operation). (Inherited from ISet) |
| AddAll(ICollection) |
Adds all of the elements in the specified collection to this set if they're not already present (optional operation). (Inherited from ISet) |
| Clear() |
Removes all of the elements from this set (optional operation). (Inherited from ISet) |
| Comparator() |
Returns the comparator used to order the elements in this set,
or |
| Contains(Object) |
Returns |
| ContainsAll(ICollection) |
Returns |
| Disposed() |
Called when the instance has been disposed. (Inherited from IJavaPeerable) |
| DisposeUnlessReferenced() |
If there are no outstanding references to this instance, then
calls |
| Equals(Object) |
Compares the specified object with this set for equality. (Inherited from ISet) |
| Finalized() |
Called when the instance has been finalized. (Inherited from IJavaPeerable) |
| First() |
Returns the first (lowest) element currently in this set. |
| ForEach(IConsumer) |
Performs the given action for each element of the |
| GetHashCode() |
Returns the hash code value for this set. (Inherited from ISet) |
| HeadSet(Object) |
Returns a view of the portion of this set whose elements are
strictly less than |
| Iterator() |
Returns an iterator over the elements in this set. (Inherited from ISet) |
| Last() |
Returns the last (highest) element currently in this set. |
| Remove(Object) |
Removes the specified element from this set if it is present (optional operation). (Inherited from ISet) |
| RemoveAll(ICollection) |
Removes from this set all of its elements that are contained in the specified collection (optional operation). (Inherited from ISet) |
| RemoveIf(IPredicate) |
Removes all of the elements of this collection that satisfy the given predicate. (Inherited from ICollection) |
| RetainAll(ICollection) |
Retains only the elements in this set that are contained in the specified collection (optional operation). (Inherited from ISet) |
| SetJniIdentityHashCode(Int32) |
Set the value returned by |
| SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from IJavaPeerable) |
| SetPeerReference(JniObjectReference) |
Set the value returned by |
| Size() |
Returns the number of elements in this set (its cardinality). (Inherited from ISet) |
| Spliterator() |
Creates a |
| SubSet(Object, Object) |
Returns a view of the portion of this set whose elements range
from |
| TailSet(Object) |
Returns a view of the portion of this set whose elements are
greater than or equal to |
| ToArray() |
Returns an array containing all of the elements in this set. (Inherited from ISet) |
| ToArray(IIntFunction) |
Returns an array containing all of the elements in this collection,
using the provided |
| ToArray(Object[]) |
Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. (Inherited from ISet) |
| UnregisterFromRuntime() |
Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable) |
Explicit Interface Implementations
| IIterable.Spliterator() |
Creates a |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |
| ToEnumerable(IIterable) | |
| ToEnumerable<T>(IIterable) | |