com.gs.collections.impl.list.immutable.ImmutableArrayList Maven / Gradle / Ivy
Show all versions of gs-collections Show documentation
/*
* Copyright 2015 Goldman Sachs.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gs.collections.impl.list.immutable;
import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.RandomAccess;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function0;
import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.predicate.Predicate;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.block.procedure.Procedure;
import com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure;
import com.gs.collections.api.list.ImmutableList;
import com.gs.collections.api.ordered.OrderedIterable;
import com.gs.collections.api.partition.list.PartitionImmutableList;
import com.gs.collections.impl.block.factory.Predicates;
import com.gs.collections.impl.block.factory.Predicates2;
import com.gs.collections.impl.list.mutable.FastList;
import com.gs.collections.impl.parallel.BatchIterable;
import com.gs.collections.impl.partition.list.PartitionImmutableListImpl;
import com.gs.collections.impl.utility.Iterate;
import com.gs.collections.impl.utility.ListIterate;
import com.gs.collections.impl.utility.internal.InternalArrayIterate;
import com.gs.collections.impl.utility.internal.RandomAccessListIterate;
import net.jcip.annotations.Immutable;
/**
* An ImmutableArrayList wraps a Java array but it cannot be modified after creation.
*/
@Immutable
final class ImmutableArrayList
extends AbstractImmutableList
implements Serializable, RandomAccess, BatchIterable
{
private static final long serialVersionUID = 1L;
private final T[] items;
private ImmutableArrayList(T[] newElements)
{
if (newElements == null)
{
throw new IllegalArgumentException("items cannot be null");
}
this.items = newElements;
}
public static ImmutableArrayList newList(Iterable iterable)
{
return new ImmutableArrayList((E[]) Iterate.toArray(iterable));
}
public static ImmutableArrayList newListWith(E... elements)
{
return new ImmutableArrayList(elements.clone());
}
public ImmutableList newWith(T newItem)
{
int oldSize = this.size();
T[] array = (T[]) new Object[oldSize + 1];
this.toArray(array);
array[oldSize] = newItem;
return new ImmutableArrayList(array);
}
@Override
public int hashCode()
{
return Arrays.hashCode(this.items);
}
@Override
public boolean equals(Object that)
{
if (that == this)
{
return true;
}
if (!(that instanceof List))
{
return false;
}
if (that instanceof ImmutableArrayList)
{
return this.immutableArrayListEquals((ImmutableArrayList) that);
}
return InternalArrayIterate.arrayEqualsList(this.items, this.items.length, (List) that);
}
public boolean immutableArrayListEquals(ImmutableArrayList otherList)
{
return Arrays.equals(this.items, otherList.items);
}
@Override
public boolean notEmpty()
{
return this.items.length > 0;
}
@Override
public T getFirst()
{
return this.isEmpty() ? null : this.items[0];
}
@Override
public T getLast()
{
return this.isEmpty() ? null : this.items[this.items.length - 1];
}
public void each(Procedure procedure)
{
for (T each : this.items)
{
procedure.value(each);
}
}
@Override
public void forEachWithIndex(ObjectIntProcedure objectIntProcedure)
{
InternalArrayIterate.forEachWithIndex(this.items, this.items.length, objectIntProcedure);
}
public void batchForEach(Procedure procedure, int sectionIndex, int sectionCount)
{
InternalArrayIterate.batchForEach(procedure, this.items, this.items.length, sectionIndex, sectionCount);
}
public int getBatchCount(int batchSize)
{
return Math.max(1, this.size() / batchSize);
}
@Override
public void forEachWithIndex(int from, int to, ObjectIntProcedure objectIntProcedure)
{
ListIterate.rangeCheck(from, to, this.items.length);
InternalArrayIterate.forEachWithIndexWithoutChecks(this.items, from, to, objectIntProcedure);
}
@Override
public ImmutableList select(Predicate predicate)
{
return InternalArrayIterate.select(this.items, this.items.length, predicate, FastList.newList()).toImmutable();
}
@Override
public ImmutableList selectWith(Predicate2 predicate, P parameter)
{
return InternalArrayIterate.selectWith(this.items, this.items.length, predicate, parameter, FastList.newList()).toImmutable();
}
@Override
public > R selectWith(
Predicate2 predicate,
P parameter,
R target)
{
return InternalArrayIterate.selectWith(this.items, this.items.length, predicate, parameter, target);
}
@Override
public ImmutableList reject(Predicate predicate)
{
return InternalArrayIterate.reject(this.items, this.items.length, predicate, FastList.newList()).toImmutable();
}
@Override
public ImmutableList rejectWith(Predicate2 predicate, P parameter)
{
return InternalArrayIterate.rejectWith(this.items, this.items.length, predicate, parameter, FastList.newList()).toImmutable();
}
@Override
public > R rejectWith(
Predicate2 predicate,
P parameter,
R target)
{
return InternalArrayIterate.rejectWith(this.items, this.items.length, predicate, parameter, target);
}
@Override
public PartitionImmutableList partition(Predicate predicate)
{
return InternalArrayIterate.partition(this.items, this.items.length, predicate).toImmutable();
}
@Override
public PartitionImmutableList partitionWith(Predicate2 predicate, P parameter)
{
return InternalArrayIterate.partitionWith(this.items, this.items.length, predicate, parameter).toImmutable();
}
@Override
public ImmutableList selectInstancesOf(Class clazz)
{
return InternalArrayIterate.selectInstancesOf(this.items, this.items.length, clazz).toImmutable();
}
@Override
public ImmutableList collect(Function function)
{
return InternalArrayIterate.collect(this.items, this.items.length, function, FastList.newList(this.items.length)).toImmutable();
}
@Override
public ImmutableList collectWith(Function2 function, P parameter)
{
return InternalArrayIterate.collectWith(this.items, this.items.length, function, parameter, FastList.newList(this.items.length)).toImmutable();
}
@Override
public ImmutableList collectIf(
Predicate predicate,
Function function)
{
return InternalArrayIterate.collectIf(this.items, this.items.length, predicate, function, FastList.newList(this.items.length)).toImmutable();
}
@Override
public > R collectWith(
Function2 function,
P parameter,
R target)
{
return InternalArrayIterate.collectWith(this.items, this.items.length, function, parameter, target);
}
@Override
public ImmutableList flatCollect(Function> function)
{
return InternalArrayIterate.flatCollect(this.items, this.items.length, function, FastList.newList(this.items.length)).toImmutable();
}
@Override
public > R flatCollect(Function> function, R target)
{
return InternalArrayIterate.flatCollect(this.items, this.items.length, function, target);
}
@Override
public T detect(Predicate predicate)
{
return InternalArrayIterate.detect(this.items, this.items.length, predicate);
}
@Override
public T detectIfNone(Predicate predicate, Function0 function)
{
T result = this.detect(predicate);
return result == null ? function.value() : result;
}
@Override
public int count(Predicate predicate)
{
return InternalArrayIterate.count(this.items, this.items.length, predicate);
}
@Override
public boolean corresponds(OrderedIterable other, Predicate2 predicate)
{
return InternalArrayIterate.corresponds(this.items, this.items.length, other, predicate);
}
@Override
public boolean anySatisfy(Predicate predicate)
{
return InternalArrayIterate.anySatisfy(this.items, this.items.length, predicate);
}
@Override
public boolean allSatisfy(Predicate predicate)
{
return InternalArrayIterate.allSatisfy(this.items, this.items.length, predicate);
}
@Override
public boolean noneSatisfy(Predicate predicate)
{
return InternalArrayIterate.noneSatisfy(this.items, this.items.length, predicate);
}
@Override
public IV injectInto(IV injectedValue, Function2 function)
{
IV result = injectedValue;
for (T each : this.items)
{
result = function.value(result, each);
}
return result;
}
public int size()
{
return this.items.length;
}
@Override
public boolean isEmpty()
{
return this.items.length == 0;
}
@Override
public boolean contains(Object o)
{
return InternalArrayIterate.anySatisfyWith(this.items, this.items.length, Predicates2.equal(), o);
}
@Override
public Iterator iterator()
{
return Arrays.asList(this.items).iterator();
}
@Override
public Object[] toArray()
{
return this.items.clone();
}
@Override
public E[] toArray(E[] a)
{
int size = this.size();
if (a.length < size)
{
a = (E[]) Array.newInstance(a.getClass().getComponentType(), size);
}
System.arraycopy(this.items, 0, a, 0, size);
if (a.length > size)
{
a[size] = null;
}
return a;
}
@Override
public void appendString(Appendable appendable, String start, String separator, String end)
{
InternalArrayIterate.appendString(this, this.items, this.items.length, appendable, start, separator, end);
}
@Override
public String toString()
{
StringBuilder buf = new StringBuilder();
buf.append('[');
int localSize = this.items.length;
T[] localItems = this.items;
for (int i = 0; i < localSize; i++)
{
T item = localItems[i];
if (i > 0)
{
buf.append(", ");
}
buf.append(item == this ? "(this ImmutableArrayList)" : String.valueOf(item));
}
buf.append(']');
return buf.toString();
}
@Override
public boolean containsAll(Collection collection)
{
return Iterate.allSatisfy(collection, Predicates.in(this.items));
}
public T get(int index)
{
return this.items[index];
}
@Override
public int indexOf(Object item)
{
return InternalArrayIterate.indexOf(this.items, this.items.length, item);
}
@Override
public int lastIndexOf(Object item)
{
return InternalArrayIterate.lastIndexOf(this.items, this.items.length, item);
}
@Override
public > T minBy(Function function)
{
return InternalArrayIterate.minBy(this.items, this.items.length, function);
}
@Override
public > T maxBy(Function function)
{
return InternalArrayIterate.maxBy(this.items, this.items.length, function);
}
@Override
public ImmutableList take(int count)
{
if (count >= this.size())
{
return this;
}
return RandomAccessListIterate.take(this, count).toImmutable();
}
@Override
public ImmutableList takeWhile(Predicate predicate)
{
int endIndex = this.detectNotIndex(predicate);
T[] result = (T[]) new Object[endIndex];
System.arraycopy(this.items, 0, result, 0, endIndex);
return new ImmutableArrayList(result);
}
@Override
public ImmutableList drop(int count)
{
if (count == 0)
{
return this;
}
return RandomAccessListIterate.drop(this, count).toImmutable();
}
@Override
public ImmutableList dropWhile(Predicate predicate)
{
int startIndex = this.detectNotIndex(predicate);
int resultSize = this.size() - startIndex;
T[] result = (T[]) new Object[resultSize];
System.arraycopy(this.items, startIndex, result, 0, resultSize);
return new ImmutableArrayList(result);
}
@Override
public PartitionImmutableList partitionWhile(Predicate predicate)
{
int partitionIndex = this.detectNotIndex(predicate);
int rejectedSize = this.size() - partitionIndex;
T[] selectedArray = (T[]) new Object[partitionIndex];
T[] rejectedArray = (T[]) new Object[rejectedSize];
System.arraycopy(this.items, 0, selectedArray, 0, partitionIndex);
System.arraycopy(this.items, partitionIndex, rejectedArray, 0, rejectedSize);
ImmutableArrayList selected = new ImmutableArrayList(selectedArray);
ImmutableArrayList rejected = new ImmutableArrayList(rejectedArray);
return new PartitionImmutableListImpl(selected, rejected);
}
private int detectNotIndex(Predicate predicate)
{
for (int index = 0; index < this.size(); index++)
{
if (!predicate.accept(this.items[index]))
{
return index;
}
}
return this.size();
}
}