Package jsonvalues

Interface ImmutableSeq

All Superinterfaces:

Iterable<JsElem>

public interface ImmutableSeq

Represents an immutable data structure where elements of a JsArray are stored. Each immutable Json factory ImmutableJsons has an implementation of this interface, that can be defined using the method ImmutableJsons.withSeq(Class). The default immutable implementation that Jsons.immutable uses is the immutable Scala Vector.

Method Summary

Modifier and Type	Method	Description
ImmutableSeq	add(int index, JsElem ele)	adds an element at the index, shifting elements at greater or equal indexes one position to the right.
ImmutableSeq	appendBack(JsElem elem)	appends the element to the back of the seq
ImmutableSeq	appendFront(JsElem elem)	appends the element to the front of the seq
boolean	contains(JsElem e)	returns true if the seq contains the element
JsElem	get(int index)	returns the element located at the index.
JsElem	head()	returns the first element of the seq.
V	init()
boolean	isEmpty()	returns true if this seq is empty
JsElem	last()	returns the last element of the seq.
ImmutableSeq	remove(int index)	removes the element located at the index.
int	size()	returns the size of the seq
V	tail()
ImmutableSeq	update(int index, JsElem ele)	updates the element located at the index with a new element.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

appendFront

ImmutableSeq appendFront(JsElem elem)

appends the element to the front of the seq

Parameters:

elem - the given element

Returns:

a seq

appendBack

ImmutableSeq appendBack(JsElem elem)

appends the element to the back of the seq

Parameters:

elem - the given element

Returns:

a seq

update

ImmutableSeq update(int index,
                    JsElem ele)

updates the element located at the index with a new element. It will be called by the library only if the index exists

Parameters:

index - the given index

ele - the given element

Returns:

an updated seq

add

ImmutableSeq add(int index,
                 JsElem ele)

adds an element at the index, shifting elements at greater or equal indexes one position to the right. It's called by the library only if the index exists

Parameters:

index - the given index

ele - the given element

Returns:

a seq

remove

ImmutableSeq remove(int index)

removes the element located at the index. It will be called by the library only if the index exists

Parameters:

index - the given index

Returns:

a seq with the element located at the index removed

head

JsElem head()

returns the first element of the seq. It's called by the library only if the seq is not empty

Returns:

the first element of the seq

tail

V tail()

init

V init()

last

JsElem last()

returns the last element of the seq. It's called by the library only if the seq is not empty

Returns:

the last element of the seq

get

JsElem get(int index)

returns the element located at the index. It's called by the library only if the index exists

Parameters:

index - the given index

Returns:

the element located at the index

size

int size()

returns the size of the seq

Returns:

the size of the seq

isEmpty

boolean isEmpty()

returns true if this seq is empty

Returns:

true if empty, false otherwise

contains

boolean contains(JsElem e)

returns true if the seq contains the element

Parameters:

e - the given element

Returns:

true if the seq contains the element, false otherwise