org.forgerock.json.fluent

Class JsonValueList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.forgerock.json.fluent.JsonValueList<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, JsonValueWrapper

public class JsonValueList<E>
extends AbstractList<E>
implements JsonValueWrapper

TODO: Description. Modification of the wrapped JSON value through this implementation is only allowed if the JSON value is a list.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
JsonValueList(JsonValue jsonValue) TODO: Description.

Method Summary

Modifier and Type	Method and Description
void	add(int index, E element) Inserts the specified element at the specified position in this list.
void	clear() Removes all of the elements from this list.
boolean	equals(Object o) Compares the specified object with this list for equality.
E	get(int index) Returns the element at the specified position in this list.
int	hashCode() Returns the hash code value for this list.
E	remove(int index) Removes the element at the specified position in this list.
E	set(int index, E element) Replaces the element at the specified position in this list with the specified element.
int	size() Returns the number of elements in this list.
JsonValue	unwrap() TODO: Description.

Methods inherited from class java.util.AbstractList

add, addAll, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

JsonValueList

public JsonValueList(JsonValue jsonValue)

TODO: Description.

Parameters:

jsonValue - TODO.

Throws:

JsonValueException - if the jsonValue is not a List.

Method Detail

unwrap

public JsonValue unwrap()

Description copied from interface: JsonValueWrapper

TODO: Description.

Specified by:

unwrap in interface JsonValueWrapper

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

get

public E get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

Parameters:

index - index of the element to return.

Returns:

the element at the specified position in this list.

Throws:

IndexOutOfBoundsException - if the index is out of range.

set

public E set(int index,
             E element)

Replaces the element at the specified position in this list with the specified element.

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

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.

Throws:

IndexOutOfBoundsException - if the index is out of range.

add

public void add(int index,
                E element)

Inserts the specified element at the specified position in this list.

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

Parameters:

index - index at which the specified element is to be inserted.

element - element to be inserted.

Throws:

IndexOutOfBoundsException - if the index is out of range.

remove

public E remove(int index)

Removes the element at the specified position in this list.

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

Parameters:

index - the index of the element to be removed.

Returns:

the element previously at the specified position.

clear

public void clear()

Removes all of the elements from this list.

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>

equals

public boolean equals(Object o)

Compares the specified object with this list for equality.

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class AbstractList<E>

Parameters:

o - the object to be compared for equality with this list.

Returns:

true if the specified object is equal to this list.

hashCode

public int hashCode()

Returns the hash code value for this list.

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class AbstractList<E>