pollLast that return and remove the lowest and highest key,
- * if one exists, else returning null.
+ * if one exists, else returning {@code null}.
*
* The return values of navigation methods may be ambiguous in
- * implementations that permit null elements. However, even
+ * implementations that permit {@code null} elements. However, even
* in this case the result can be disambiguated by checking
- * contains(null). To avoid such issues, implementations of
+ * {@code contains(null)}. To avoid such issues, implementations of
* this interface are encouraged not to permit insertion of
- * null elements. (Note that sorted sets of {@link
- * Comparable} elements intrinsically do not permit null.)
+ * {@code null} elements. (Note that sorted sets of {@link
+ * Comparable} elements intrinsically do not permit {@code null}.)
*
* @author Doug Lea
* @param the type of elements maintained by this set
@@ -37,71 +37,71 @@ import java.util.*;
public interface NavigableSet extends SortedSet {
/**
* Returns an element greater than or equal to the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return an element greater than or equal to given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
* @throws ClassCastException if o cannot be compared with the elements
* currently in the set.
- * @throws NullPointerException if o is null
- * and this set deas not permit null elements
+ * @throws NullPointerException if o is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public E ceiling(E o);
/**
* Returns an element strictly less than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return the greatest element less than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
* @throws ClassCastException if o cannot be compared with the elements
* currently in the set
- * @throws NullPointerException if o is null
- * and this set deas not permit null elements
+ * @throws NullPointerException if o is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public E lower(E o);
/**
* Returns an element less than or equal to the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return the greatest element less than or equal to given
- * element, or null if there is no such element
+ * element, or {@code null} if there is no such element
* @throws ClassCastException if o cannot be compared with the elements
* currently in the set
- * @throws NullPointerException if o is null
- * and this set deas not permit null elements
+ * @throws NullPointerException if o is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public E floor(E o);
/**
* Returns an element strictly greater than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return the least element greater than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
* @throws ClassCastException if o cannot be compared with the elements
* currently in the set
- * @throws NullPointerException if o is null
- * and this set deas not permit null elements
+ * @throws NullPointerException if o is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public E higher(E o);
/**
* Retrieves and removes the first (lowest) element.
*
- * @return the first element, or null if empty
+ * @return the first element, or {@code null} if empty
*/
public E pollFirst();
/**
* Retrieves and removes the last (highest) element.
*
- * @return the last element, or null if empty
+ * @return the last element, or {@code null} if empty
*/
public E pollLast();
@@ -109,64 +109,64 @@ public interface NavigableSet extends
* Returns an iterator over the elements in this collection, in
* descending order.
*
- * @return an Iterator over the elements in this collection
+ * @return an {@code Iterator} over the elements in this collection
*/
Iterator descendingIterator();
/**
* Returns a view of the portion of this set whose elements range from
- * fromElement, inclusive, to toElement, exclusive. (If
- * fromElement and toElement are equal, the returned
+ * {@code fromElement}, inclusive, to {@code toElement}, exclusive. (If
+ * {@code fromElement} and {@code toElement} are equal, the returned
* sorted set is empty.) The returned sorted set is backed by this set,
* so changes in the returned sorted set are reflected in this set, and
* vice-versa.
* @param fromElement low endpoint (inclusive) of the subSet
* @param toElement high endpoint (exclusive) of the subSet
* @return a view of the portion of this set whose elements range from
- * fromElement, inclusive, to toElement,
+ * {@code fromElement}, inclusive, to {@code toElement},
* exclusive
- * @throws ClassCastException if fromElement and
- * toElement cannot be compared to one another using
+ * @throws ClassCastException if {@code fromElement} and
+ * {@code toElement} cannot be compared to one another using
* this set's comparator (or, if the set has no comparator,
* using natural ordering)
- * @throws IllegalArgumentException if fromElement is
- * greater than toElement
- * @throws NullPointerException if fromElement or
- * toElement is null
- * and this set deas not permit null elements
+ * @throws IllegalArgumentException if {@code fromElement} is
+ * greater than {@code toElement}
+ * @throws NullPointerException if {@code fromElement} or
+ * {@code toElement} is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public NavigableSet subSet(E fromElement, E toElement);
/**
* Returns a view of the portion of this set whose elements are strictly
- * less than toElement. The returned sorted set is backed by
+ * less than {@code toElement}. The returned sorted set is backed by
* this set, so changes in the returned sorted set are reflected in this
* set, and vice-versa.
* @param toElement high endpoint (exclusive) of the headSet
* @return a view of the portion of this set whose elements are strictly
* less than toElement
- * @throws ClassCastException if toElement is not compatible
+ * @throws ClassCastException if {@code toElement} is not compatible
* with this set's comparator (or, if the set has no comparator,
- * if toElement does not implement Comparable)
- * @throws NullPointerException if toElement is null
- * and this set deas not permit null elements
+ * if {@code toElement} does not implement {@code Comparable})
+ * @throws NullPointerException if {@code toElement} is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public NavigableSet headSet(E toElement);
/**
* Returns a view of the portion of this set whose elements are
- * greater than or equal to fromElement. The returned
+ * greater than or equal to {@code fromElement}. The returned
* sorted set is backed by this set, so changes in the returned
* sorted set are reflected in this set, and vice-versa.
* @param fromElement low endpoint (inclusive) of the tailSet
* @return a view of the portion of this set whose elements are
- * greater than or equal to fromElement
- * @throws ClassCastException if fromElement is not
+ * greater than or equal to {@code fromElement}
+ * @throws ClassCastException if {@code fromElement} is not
* compatible with this set's comparator (or, if the set has no
- * comparator, if fromElement does not implement
- * Comparable)
- * @throws NullPointerException if fromElement is null
- * and this set deas not permit null elements
+ * comparator, if {@code fromElement} does not implement
+ * {@code Comparable})
+ * @throws NullPointerException if {@code fromElement} is {@code null}
+ * and this set deas not permit {@code null} elements
*/
public NavigableSet tailSet(E fromElement);
}