Package com.google.protobuf

Class AbstractProtobufList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.google.protobuf.AbstractProtobufList<E>

All Implemented Interfaces:

Internal.ProtobufList<E>, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess

Direct Known Subclasses:

BooleanArrayList, DoubleArrayList, FloatArrayList, IntArrayList, LazyStringArrayList, LongArrayList, ProtobufArrayList

abstract class AbstractProtobufList<E>
extends java.util.AbstractList<E>
implements Internal.ProtobufList<E>

An abstract implementation of Internal.ProtobufList which manages mutability semantics. All mutate methods must check if the list is mutable before proceeding. Subclasses must invoke ensureIsMutable() manually when overriding those methods.

This implementation assumes all subclasses are array based, supporting random access.

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DEFAULT_CAPACITY
private boolean	isMutable	Whether or not this list is modifiable.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AbstractProtobufList()	Constructs a mutable list by default.
AbstractProtobufList(boolean isMutable)	Constructs an immutable list for EMPTY lists

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)
boolean	add(E e)
boolean	addAll(int index, java.util.Collection<? extends E> c)
boolean	addAll(java.util.Collection<? extends E> c)
void	clear()
protected void	ensureIsMutable()	Throws an UnsupportedOperationException if the list is immutable.
boolean	equals(java.lang.Object o)
int	hashCode()
boolean	isModifiable()	Returns whether this list can be modified via the publicly accessible List methods.
void	makeImmutable()	Makes this list immutable.
E	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
E	set(int index, E element)

Methods inherited from class java.util.AbstractList

get, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface com.google.protobuf.Internal.ProtobufList

mutableCopyWithCapacity

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, replaceAll, size, sort, spliterator, subList, toArray, toArray

Field Detail

DEFAULT_CAPACITY

protected static final int DEFAULT_CAPACITY

See Also:

Constant Field Values

isMutable

private boolean isMutable

Whether or not this list is modifiable.

Constructor Detail

AbstractProtobufList

AbstractProtobufList()

Constructs a mutable list by default.

AbstractProtobufList

AbstractProtobufList(boolean isMutable)

Constructs an immutable list for EMPTY lists

Method Detail

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface java.util.List<E>

Overrides:

equals in class java.util.AbstractList<E>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface java.util.List<E>

Overrides:

hashCode in class java.util.AbstractList<E>

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

add

public void add(int index,
                E element)

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractCollection<E>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractList<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Overrides:

clear in class java.util.AbstractList<E>

isModifiable

public boolean isModifiable()

Description copied from interface: Internal.ProtobufList

Returns whether this list can be modified via the publicly accessible List methods.

Specified by:

isModifiable in interface Internal.ProtobufList<E>

makeImmutable

public final void makeImmutable()

Description copied from interface: Internal.ProtobufList

Makes this list immutable. All subsequent modifications will throw an UnsupportedOperationException.

Specified by:

makeImmutable in interface Internal.ProtobufList<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractList<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractCollection<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

Overrides:

removeAll in class java.util.AbstractCollection<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.List<E>

Overrides:

retainAll in class java.util.AbstractCollection<E>

set

public E set(int index,
             E element)

Specified by:

set in interface java.util.List<E>

Overrides:

set in class java.util.AbstractList<E>

ensureIsMutable

protected void ensureIsMutable()

Throws an UnsupportedOperationException if the list is immutable. Subclasses are responsible for invoking this method on mutate operations.