Package org.apache.juneau.collections

Class ControlledArrayList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

org.apache.juneau.collections.ControlledArrayList<E>

Type Parameters:

E - The element type.

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess

Direct Known Subclasses:

HeaderList, PartList

public class ControlledArrayList<E>
extends ArrayList<E>

An array list that allows you to control whether it's read-only via a constructor parameter.

Override methods such as overrideAdd(int, Object) are provided that bypass the unmodifiable restriction on the list. They allow you to manipulate the list while not exposing the ability to manipulate the list through any of the methods provided by the List interface (meaning you can pass the object around as an unmodifiable List).

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ControlledArrayList(boolean unmodifiable)	Constructor.
ControlledArrayList(boolean unmodifiable, List<? extends E> list)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)
boolean	add(E element)
boolean	addAll(int index, Collection<? extends E> c)
boolean	addAll(Collection<? extends E> c)
protected final void	assertModifiable()	Throws an UnsupportedOperationException if the unmodifiable flag is set on this bean.
void	clear()
boolean	isModifiable()	Returns true if this list is modifiable.
Iterator<E>	iterator()
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
void	overrideAdd(int index, E element)	Same as add(int, Object) but bypasses the modifiable flag.
boolean	overrideAdd(E element)	Same as add(Object) but bypasses the modifiable flag.
boolean	overrideAddAll(int index, Collection<? extends E> c)	Same as addAll(int,Collection) but bypasses the modifiable flag.
boolean	overrideAddAll(Collection<? extends E> c)	Same as addAll(Collection) but bypasses the modifiable flag.
void	overrideClear()	Same as clear() but bypasses the modifiable flag.
Iterator<E>	overrideIterator()	Same as iterator() but bypasses the modifiable flag.
ListIterator<E>	overrideListIterator(int index)	Same as listIterator() but bypasses the modifiable flag.
E	overrideRemove(int index)	Same as remove(int) but bypasses the modifiable flag.
boolean	overrideRemove(Object o)	Same as remove(Object) but bypasses the modifiable flag.
boolean	overrideRemoveAll(Collection<?> c)	Same as removeAll(Collection) but bypasses the modifiable flag.
boolean	overrideRemoveIf(Predicate<? super E> filter)	Same as removeIf(Predicate) but bypasses the modifiable flag.
void	overrideReplaceAll(UnaryOperator<E> operator)	Same as replaceAll(UnaryOperator) but bypasses the modifiable flag.
boolean	overrideRetainAll(Collection<?> c)	Same as retainAll(Collection) but bypasses the modifiable flag.
E	overrideSet(int index, E element)	Same as set(int, Object) but bypasses the modifiable flag.
void	overrideSort(Comparator<? super E> c)	Same as overrideSort(Comparator) but bypasses the modifiable flag.
E	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> coll)
boolean	removeIf(Predicate<? super E> filter)
void	replaceAll(UnaryOperator<E> operator)
boolean	retainAll(Collection<?> c)
E	set(int index, E element)
ControlledArrayList<E>	setUnmodifiable()	Specifies whether this bean should be unmodifiable.
void	sort(Comparator<? super E> c)
List<E>	subList(int fromIndex, int toIndex)

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, lastIndexOf, removeRange, size, spliterator, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

ControlledArrayList

public ControlledArrayList(boolean unmodifiable)

Constructor.

Parameters:

unmodifiable - If true, this list cannot be modified through normal list operation methods on the List interface.

ControlledArrayList

public ControlledArrayList(boolean unmodifiable,
 List<? extends E> list)

Constructor.

Parameters:

unmodifiable - If true, this list cannot be modified through normal list operation methods on the List interface.

list - The initial contents of this list.

Method Details

setUnmodifiable

public ControlledArrayList<E> setUnmodifiable()

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Returns:

This object.

assertModifiable

protected final void assertModifiable()

Throws an UnsupportedOperationException if the unmodifiable flag is set on this bean.

isModifiable

public boolean isModifiable()

Returns true if this list is modifiable.

Returns:

true if this list is modifiable.

set

public E set(int index,
 E element)

Specified by:

set in interface List<E>

Overrides:

set in class ArrayList<E>

overrideSet

public E overrideSet(int index,
 E element)

Same as set(int, Object) but bypasses the modifiable flag.

Parameters:

index - Index of the element to replace.

element - Element to be stored at the specified position.

Returns:

The element previously at the specified position.

add

public void add(int index,
 E element)

Specified by:

add in interface List<E>

Overrides:

add in class ArrayList<E>

overrideAdd

public void overrideAdd(int index,
 E element)

Same as add(int, Object) but bypasses the modifiable flag.

Parameters:

index - Index of the element to replace.

element - Element to be stored at the specified position.

remove

public E remove(int index)

Specified by:

remove in interface List<E>

Overrides:

remove in class ArrayList<E>

overrideRemove

public E overrideRemove(int index)

Same as remove(int) but bypasses the modifiable flag.

Parameters:

index - Index of the element to remove.

Returns:

The element that was removed from the list.

addAll

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

Specified by:

addAll in interface List<E>

Overrides:

addAll in class ArrayList<E>

overrideAddAll

public boolean overrideAddAll(int index,
 Collection<? extends E> c)

Same as addAll(int,Collection) but bypasses the modifiable flag.

Parameters:

index - Index at which to insert the first element from the specified collection.

c - Collection containing elements to be added to this list.

Returns:

true if this list changed as a result of the call.

replaceAll

public void replaceAll(UnaryOperator<E> operator)

Specified by:

replaceAll in interface List<E>

Overrides:

replaceAll in class ArrayList<E>

overrideReplaceAll

public void overrideReplaceAll(UnaryOperator<E> operator)

Same as replaceAll(UnaryOperator) but bypasses the modifiable flag.

Parameters:

operator - The operator to apply to each element.

sort

public void sort(Comparator<? super E> c)

Specified by:

sort in interface List<E>

Overrides:

sort in class ArrayList<E>

overrideSort

public void overrideSort(Comparator<? super E> c)

Same as overrideSort(Comparator) but bypasses the modifiable flag.

Parameters:

c - The Comparator used to compare list elements. A null value indicates that the elements' natural ordering should be used.

add

public boolean add(E element)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class ArrayList<E>

overrideAdd

public boolean overrideAdd(E element)

Same as add(Object) but bypasses the modifiable flag.

Parameters:

element - Element to be stored at the specified position.

Returns:

true.

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class ArrayList<E>

overrideRemove

public boolean overrideRemove(Object o)

Same as remove(Object) but bypasses the modifiable flag.

Parameters:

o - Element to be removed from this list, if present.

Returns:

true if this list contained the specified element.

addAll

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

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class ArrayList<E>

overrideAddAll

public boolean overrideAddAll(Collection<? extends E> c)

Same as addAll(Collection) but bypasses the modifiable flag.

Parameters:

c - Collection containing elements to be added to this list.

Returns:

true if this list changed as a result of the call.

removeAll

public boolean removeAll(Collection<?> coll)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class ArrayList<E>

overrideRemoveAll

public boolean overrideRemoveAll(Collection<?> c)

Same as removeAll(Collection) but bypasses the modifiable flag.

Parameters:

c - Collection containing elements to be removed from this list.

Returns:

true if this list changed as a result of the call.

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

Overrides:

retainAll in class ArrayList<E>

overrideRetainAll

public boolean overrideRetainAll(Collection<?> c)

Same as retainAll(Collection) but bypasses the modifiable flag.

Parameters:

c - Collection containing elements to be retained in this list.

Returns:

true if this list changed as a result of the call.

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class ArrayList<E>

overrideClear

public void overrideClear()

Same as clear() but bypasses the modifiable flag.

removeIf

public boolean removeIf(Predicate<? super E> filter)

Specified by:

removeIf in interface Collection<E>

Overrides:

removeIf in class ArrayList<E>

overrideRemoveIf

public boolean overrideRemoveIf(Predicate<? super E> filter)

Same as removeIf(Predicate) but bypasses the modifiable flag.

Parameters:

filter - A predicate which returns true for elements to be removed.

Returns:

true if any elements were removed.

subList

public List<E> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<E>

Overrides:

subList in class ArrayList<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class ArrayList<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class ArrayList<E>

overrideListIterator

public ListIterator<E> overrideListIterator(int index)

Same as listIterator() but bypasses the modifiable flag.

Parameters:

index - Index of the first element to be returned from the list iterator.

Returns:

A list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface List<E>

Overrides:

iterator in class ArrayList<E>

overrideIterator

public Iterator<E> overrideIterator()

Same as iterator() but bypasses the modifiable flag.

Returns:

An iterator over the elements in this list in proper sequence.