Overrides org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection.add.

Implements java.util.Collection.add, java.util.List.add, org.eclipse.collections.api.collection.FixedSizeCollection.add.

Doc from java.util.List.add.

Appends the specified element to the end of this list (optional operation).

Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Annotations

@Override

Implements java.util.List.add.

Doc from java.util.List.add.

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Annotations

@Override

Overrides org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection.addAll.

Implements java.util.Collection.addAll, java.util.List.addAll, org.eclipse.collections.api.collection.FixedSizeCollection.addAll.

Doc from java.util.List.addAll.

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Annotations

@Override

Implements java.util.List.addAll.

Doc from java.util.List.addAll.

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Annotations

@Override

Overrides org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection.addAllIterable.

Implements org.eclipse.collections.api.collection.MutableCollection.addAllIterable, org.eclipse.collections.api.collection.FixedSizeCollection.addAllIterable.

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.clear.

Implements java.util.Collection.clear, java.util.List.clear, org.eclipse.collections.api.collection.FixedSizeCollection.clear.

Doc from java.util.List.clear.

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.clone.

Implements org.eclipse.collections.api.list.MutableList.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

x.clone().getClass() == x.getClass()

x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.listIterator.

Implements java.util.List.listIterator, org.eclipse.collections.api.list.ListIterable.listIterator.

Doc from java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.listIterator.

Implements java.util.List.listIterator, org.eclipse.collections.api.list.ListIterable.listIterator.

Doc from java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence).

Annotations

@Override

Overrides org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection.remove.

Implements java.util.Collection.remove, java.util.List.remove, org.eclipse.collections.api.collection.FixedSizeCollection.remove.

Doc from java.util.List.remove.

Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that Objects.equals(o, get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Annotations

@Override

Implements java.util.List.remove.

Doc from java.util.List.remove.

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.removeAll.

Implements java.util.Collection.removeAll, java.util.List.removeAll, org.eclipse.collections.api.collection.FixedSizeCollection.removeAll.

Doc from java.util.List.removeAll.

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Annotations

@Override

Overrides org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection.removeAllIterable.

Implements org.eclipse.collections.api.collection.MutableCollection.removeAllIterable, org.eclipse.collections.api.collection.FixedSizeCollection.removeAllIterable.

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.removeIf.

Implements org.eclipse.collections.api.collection.MutableCollection.removeIf, org.eclipse.collections.api.collection.FixedSizeCollection.removeIf.

Doc from org.eclipse.collections.api.collection.MutableCollection.removeIf.

Removes all elements in the collection that evaluate to true for the specified predicate.

e.g.
return lastNames.removeIf(Predicates.isNull());

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.removeIfWith.

Implements org.eclipse.collections.api.collection.MutableCollection.removeIfWith, org.eclipse.collections.api.collection.FixedSizeCollection.removeIfWith.

Doc from org.eclipse.collections.api.collection.MutableCollection.removeIfWith.

Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.

return lastNames.removeIfWith(Predicates2.isNull(), null);

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.retainAll.

Implements java.util.Collection.retainAll, java.util.List.retainAll, org.eclipse.collections.api.collection.FixedSizeCollection.retainAll.

Doc from java.util.List.retainAll.

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.

Annotations

@Override

Overrides org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection.retainAllIterable.

Implements org.eclipse.collections.api.collection.MutableCollection.retainAllIterable, org.eclipse.collections.api.collection.FixedSizeCollection.retainAllIterable.

Annotations

@Override

Overrides default java.util.List.sort.

This method checks if comparator is null and use a ComparableComparator if it is.

Annotations

@Override

Since

10.0

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.subList.

Implements org.eclipse.collections.api.list.MutableList.subList.

Doc from java.util.List.subList.

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

list.subList(from, to).clear();

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Annotations

@Override

Overrides org.eclipse.collections.impl.list.mutable.AbstractMutableList.tap.

Overrides default org.eclipse.collections.api.list.MutableList.tap.

Implements org.eclipse.collections.api.list.FixedSizeList.tap, org.eclipse.collections.api.collection.MutableCollection.tap, org.eclipse.collections.api.RichIterable.tap.

Doc from org.eclipse.collections.api.RichIterable.tap.

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Annotations

@Override

Overrides default org.eclipse.collections.api.list.MutableList.toReversed.

Implements org.eclipse.collections.api.list.FixedSizeList.toReversed.

Doc from org.eclipse.collections.api.list.MutableList.toReversed.

Returns a new MutableList in reverse order.

Annotations

@Override

Overrides default org.eclipse.collections.api.list.MutableList.withAll.

Implements org.eclipse.collections.api.list.FixedSizeList.withAll, org.eclipse.collections.api.collection.MutableCollection.withAll.

Doc from org.eclipse.collections.api.collection.FixedSizeCollection.withAll.

This method allows fixed size collections the ability to add multiple elements to their existing elements. A new instance of MutableCollection is returned containing the elements of the original collection with all the new elements addAll(Collection) added. Implementations will return a new FixedSizeCollection where possible. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

MutableCollection<String> list;
list = list.withAll(FastList.newListWith("1", "2"));
return list;

Annotations

@Override

Overrides default org.eclipse.collections.api.list.MutableList.without.

Implements org.eclipse.collections.api.list.FixedSizeList.without, org.eclipse.collections.api.collection.MutableCollection.without.

Doc from org.eclipse.collections.api.collection.FixedSizeCollection.without.

This method allows fixed size collections the ability to remove elements from their existing elements. A new instance of MutableCollection is returned containing the elements of the original collection with the element removed. Implementations will return a new FixedSizeCollection where possible. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

MutableCollection<String> list;
list = list.without("1");
list = list.without("2");
return list;

Annotations

@Override

Overrides default org.eclipse.collections.api.list.MutableList.withoutAll.

Implements org.eclipse.collections.api.list.FixedSizeList.withoutAll, org.eclipse.collections.api.collection.MutableCollection.withoutAll.

Doc from org.eclipse.collections.api.collection.FixedSizeCollection.withoutAll.

This method allows fixed size collections the ability to remove multiple elements from their existing elements. A new instance of MutableCollection is returned containing the elements of the original collection with the given elements removed. Implementations will return a new FixedSizeCollection where possible. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

MutableCollection<String> list;
list = list.withoutAll(FastList.newListWith("1", "2"));
return list;

Annotations

@Override