Package ortus.boxlang.runtime.types.immutable

Class ImmutableArray

java.lang.Object

ortus.boxlang.runtime.types.Array

ortus.boxlang.runtime.types.immutable.ImmutableArray

All Implemented Interfaces:

Serializable, Iterable<Object>, Collection<Object>, List<Object>, SequencedCollection<Object>, IReferenceable, IImmutable, IType, IListenable

public class ImmutableArray
extends Array
implements IImmutable

Represents an immutable Array. All data you want needs to be passed in the constructor or provided to a static creation method. Once instantiated, the Array cannot be modified. An exception will be thrown if you invoke any mutator method.

See Also:

• Serialized Form

Field Summary

Fields inherited from class ortus.boxlang.runtime.types.Array

$bx, containsDelimiters, EMPTY, wrapped

Fields inherited from interface ortus.boxlang.runtime.types.meta.IListenable

ALL_KEYS

Constructor Summary

Constructors

Constructor	Description
ImmutableArray()	Constructor to create default array
ImmutableArray(int initialCapactity)	Constructor to create array with an initial capacity
ImmutableArray(Object[] arr)	Constructor to create a Array from a Java array
ImmutableArray(List<? extends Object> list)	Constructor to create a Array from a List

Method Summary

Modifier and Type	Method	Description
boolean	add(Object e)
boolean	addAll(int index, Collection<? extends Object> c)
boolean	addAll(Collection<? extends Object> c)
int	append(Object e)
Object	assign(IBoxContext context, Key key, Object value)	Assign a value to a key
void	clear()	Clears the contents contents of the array
static ImmutableArray	fromArray(Object[] arr)	Create a Array from a Java array
static ImmutableArray	fromList(List<? extends Object> list)	Create a Array from a List
static ImmutableArray	of(Object... values)	Create a Array from a list of values.
Object	remove(int index)	Remove an element at a specified index
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
Array	toMutable()	To Mutable

Methods inherited from class ortus.boxlang.runtime.types.Array

add, asString, contains, containsAll, copyOf, deleteAt, dereference, dereferenceAndInvoke, dereferenceAndInvoke, equals, findIndex, findIndex, findIndex, findIndexWithSubstring, fromString, fromString, get, getAt, getBoxMeta, getIntFromKey, hashCode, indexOf, insertAt, intStream, isEmpty, iterator, lastIndexOf, listIterator, listIterator, parallelStream, push, registerChangeListener, registerChangeListener, removeAt, removeChangeListener, removeDuplicates, removeDuplicates, reverse, set, setAt, size, sort, stream, subList, toArray, toArray, toImmutable, toList, toString, validateAndGetIntForAssign, validateAndGetIntForDereference, withDelimiters

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

removeIf, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, spliterator

Constructor Details

ImmutableArray

public ImmutableArray()

Constructor to create default array

ImmutableArray

public ImmutableArray(int initialCapactity)

Constructor to create array with an initial capacity

Parameters:

initialCapactity - The initialCapactity of Array to create

ImmutableArray

public ImmutableArray(Object[] arr)

Constructor to create a Array from a Java array

Parameters:

arr - The array to create the Array from

ImmutableArray

public ImmutableArray(List<? extends Object> list)

Constructor to create a Array from a List

Parameters:

list - The List to create the Array from

Method Details

toMutable

public Array toMutable()

To Mutable

Specified by:

toMutable in interface IImmutable

Returns:

The mutable type

fromList

public static ImmutableArray fromList(List<? extends Object> list)

Create a Array from a List

Parameters:

list - The List to create the Array from

fromArray

public static ImmutableArray fromArray(Object[] arr)

Create a Array from a Java array

Parameters:

arr - The array to create the Array from

of

public static ImmutableArray of(Object... values)

Create a Array from a list of values.

Parameters:

values - The values to create the Array from

Returns:

The Array

add

public boolean add(Object e)

Specified by:

add in interface Collection<Object>

Specified by:

add in interface List<Object>

Overrides:

add in class Array

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Object>

Specified by:

remove in interface List<Object>

Overrides:

remove in class Array

addAll

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

Specified by:

addAll in interface Collection<Object>

Specified by:

addAll in interface List<Object>

Overrides:

addAll in class Array

addAll

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

Specified by:

addAll in interface List<Object>

Overrides:

addAll in class Array

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<Object>

Specified by:

removeAll in interface List<Object>

Overrides:

removeAll in class Array

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<Object>

Specified by:

retainAll in interface List<Object>

Overrides:

retainAll in class Array

clear

public void clear()

Description copied from class: Array

Clears the contents contents of the array

Specified by:

clear in interface Collection<Object>

Specified by:

clear in interface List<Object>

Overrides:

clear in class Array

remove

public Object remove(int index)

Description copied from class: Array

Remove an element at a specified index

Specified by:

remove in interface List<Object>

Overrides:

remove in class Array

append

public int append(Object e)

Overrides:

append in class Array

assign

public Object assign(IBoxContext context,
 Key key,
 Object value)

Assign a value to a key

Specified by:

assign in interface IReferenceable

Overrides:

assign in class Array

Parameters:

context - The context we're executing inside of

key - The key to assign

value - The value to assign

Returns:

The assigned value