xyz.avarel.aje.runtime.collections

Class Vector

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Obj>

xyz.avarel.aje.runtime.collections.Vector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Obj>, java.util.Collection<Obj>, java.util.List<Obj>, java.util.RandomAccess, NativeObject<java.util.List<java.lang.Object>>, Obj

public class Vector
extends java.util.ArrayList<Obj>
implements Obj, java.lang.Iterable<Obj>, NativeObject<java.util.List<java.lang.Object>>

AJE wrapper class for a one dimensional vector.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Type	TYPE

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Vector() Creates an empty vector.

Method Summary

Modifier and Type	Method and Description
Obj	divide(Obj other) Division operator in AJE.
Obj	get(int index)
Obj	get(Obj key) Get operator in AJE.
Obj	getAttr(java.lang.String name) Attribute operator in AJE.
Type	getType()
Bool	isEqualTo(Obj other) Equality operator in AJE.
Bool	isEqualTo(Vector other)
Obj	minus(Obj other) Subtraction operator in AJE.
Vector	negative() Negative numeric unary operator in AJE.
static Vector	of(Obj... items) Creates a vector of items.
static Vector	ofList(java.util.Collection<Obj> collection) Creates a vector of items from a native collection.
Obj	plus(Obj other) Addition operator in AJE.
Obj	pow(Obj other) Exponentiation operator in AJE.
Obj	set(int index, Obj element)
Obj	set(Obj key, Obj value)
Obj	slice(Obj startObj, Obj endObj, Obj stepObj)
Obj	times(Obj other) Multiplication operator in AJE.
java.util.List<java.lang.Object>	toNative() Returns an unmodifiable representation of the vector.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

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 xyz.avarel.aje.runtime.Obj

and, divide, divide, greaterThan, identity, invoke, invoke, isNativeObject, lessThan, minus, minus, mod, mod, mod, negate, or, plus, plus, pow, pow, setAttr, times, times

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

TYPE

public static final Type TYPE

Constructor Detail

Vector

public Vector()

Creates an empty vector.

Method Detail

of

public static Vector of(Obj... items)

Creates a vector of items.

Parameters:

items - Obj items to put into the list.

Returns:

The created Vector.

ofList

public static Vector ofList(java.util.Collection<Obj> collection)

Creates a vector of items from a native collection.

Parameters:

collection - Native collection of AJE objects.

Returns:

The created Vector.

toNative

public java.util.List<java.lang.Object> toNative()

Returns an unmodifiable representation of the vector. Note that the list's contents are all converted to their native representation or null if unable to.

Specified by:

toNative in interface NativeObject<java.util.List<java.lang.Object>>

Specified by:

toNative in interface Obj

Returns:

An unmodifiable representation of the vector.

getType

public Type getType()

Specified by:

getType in interface Obj

Returns:

The Type of the object.

plus

public Obj plus(Obj other)

Description copied from interface: Obj

Addition operator in AJE. Default symbol is +.
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

plus in interface Obj

Parameters:

other - Right Obj operand.

Returns:

The Obj result of the operation.

minus

public Obj minus(Obj other)

Description copied from interface: Obj

Subtraction operator in AJE. Default symbol is -.
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

minus in interface Obj

Parameters:

other - Right Obj operand.

Returns:

The Obj result of the operation.

times

public Obj times(Obj other)

Description copied from interface: Obj

Multiplication operator in AJE. Default symbol is *.
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

times in interface Obj

Parameters:

other - Right Obj operand.

Returns:

The Obj result of the operation.

divide

public Obj divide(Obj other)

Description copied from interface: Obj

Division operator in AJE. Default symbol is /.
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

divide in interface Obj

Parameters:

other - Right Obj operand.

Returns:

The Obj result of the operation.

pow

public Obj pow(Obj other)

Description copied from interface: Obj

Exponentiation operator in AJE. Default symbol is ^.
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

pow in interface Obj

Parameters:

other - Right Obj operand.

Returns:

The Obj result of the operation.

negative

public Vector negative()

Description copied from interface: Obj

Negative numeric unary operator in AJE. Default symbol is -.

Specified by:

negative in interface Obj

Returns:

The Obj result of the operation.

isEqualTo

public Bool isEqualTo(Obj other)

Description copied from interface: Obj

Equality operator in AJE. Default symbol is ==.
Implementation should defaults to returning Bool representation of Object.equals(Object) if not implemented.

Specified by:

isEqualTo in interface Obj

Parameters:

other - Right Obj operand.

Returns:

The Obj result of the operation.

isEqualTo

public Bool isEqualTo(Vector other)

slice

public Obj slice(Obj startObj,
                 Obj endObj,
                 Obj stepObj)

Specified by:

slice in interface Obj

get

public Obj get(Obj key)

Description copied from interface: Obj

Get operator in AJE. Default symbol is a[b].
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

get in interface Obj

Parameters:

key - Right Obj operand.

Returns:

The Obj result of the operation.

set

public Obj set(Obj key,
               Obj value)

Specified by:

set in interface Obj

set

public Obj set(int index,
               Obj element)

Specified by:

set in interface java.util.List<Obj>

Overrides:

set in class java.util.ArrayList<Obj>

get

public Obj get(int index)

Specified by:

get in interface java.util.List<Obj>

Overrides:

get in class java.util.ArrayList<Obj>

getAttr

public Obj getAttr(java.lang.String name)

Description copied from interface: Obj

Attribute operator in AJE. Default symbol is a.b.
Implementation should defaults to returning Undefined.VALUE if not implemented.

Specified by:

getAttr in interface Obj

Parameters:

name - Attribute name.

Returns:

The Obj result of the operation.