moduleceylon.json1.2.2
Source Code
ceylon.json
classArray
extends Basic
satisfies MutableList<Value>
OverviewPackageInitializerAttributesMethods

Represents a JSON Array

By: Stéphane Épardaud

no subtypes hierarchy

Initializer
Array({Value*} values = ...)
Parameters:
  • values = {}
Attributes
arraysSource Codeshared {Array*} arrays

Returns this array as a sequence of Array elements.

Throws
booleansSource Codeshared {Boolean*} booleans

Returns this array as a sequence of Boolean elements.

Throws
floatsSource Codeshared {Float*} floats

Returns this array as a sequence of Float elements.

Throws
hashSource Codeshared actual Integer hash

The hash value of the value, which allows the value to be an element of a hash-based set or key of a hash-based map. Implementations must respect the constraint that:

  • if x==y then x.hash==y.hash.

Therefore, a class which refines equals must also refine hash.

In general, hash values vary between platforms and between executions of the same program.

Note that when executing on a Java Virtual Machine, the 64-bit Integer value returned by an implementation of hash is truncated to a 32-bit integer value by removal of the 32 highest order bits, before returning the value to the caller.

Refines Identifiable.hash ultimately refines Object.hash
integersSource Codeshared {Integer*} integers

Returns this array as a sequence of Integer elements.

Throws
lastIndexSource Codeshared actual Integer? lastIndex

The index of the last element of the list, or null if the list is empty. Always size>0 then size-1.

Refines List.lastIndex
objectsSource Codeshared {Object*} objects

Returns this array as a sequence of Object elements.

Throws
prettySource Codeshared String pretty

Returns a pretty-printed serialised JSON representation

restSource Codeshared actual Array rest

A stream containing all but the first element of this stream. For a stream with an unstable iteration order, a different stream might be produced each time rest is evaluated.

Therefore, if the stream i has an unstable iteration order, the stream { i.first, *i.rest } might not have the same elements as i.

Refines List.rest ultimately refines Iterable.rest
reversedSource Codeshared actual Array reversed

A list containing the elements of this list in reverse order to the order in which they occur in this list. For every index of a reversed list:

list.reversed[index]==list[size-1-index]

This is a lazy operation returning a view of this list.

Refines List.reversed
sizeSource Codeshared actual Integer size

Returns the number of elements in this array

Refines List.size ultimately refines Iterable.size
stringSource Codeshared actual String string

Returns a serialised JSON representation

Refines Collection.string ultimately refines Object.string
stringsSource Codeshared {String*} strings

Returns this array as a sequence of String elements.

Throws
Inherited Attributes
Attributes inherited from: LangObject
hash, string
Attributes inherited from: Collection<Element>
empty, permutations, string
Attributes inherited from: Correspondence<Key,Item>
keys
Attributes inherited from: Iterable<Element,Absent>
coalesced, cycled, distinct, empty, exceptLast, first, indexed, last, paired, rest, size, string
Attributes inherited from: List<Element>
first, hash, keys, last, lastIndex, rest, reversed, size
Methods
addSource Codeshared actual void add(Value val)

Adds a new value at the end of this array

Refines ListMutator.add
addAllSource Codeshared actual void addAll({Value*} values)

Add the given elements to the end of this list, increasing the length of the list.

Refines ListMutator.addAll
clearSource Codeshared actual void clear()

Remove every element from this list, leaving an empty list with no elements.

Refines ListMutator.clear
cloneSource Codeshared actual Array clone()

A shallow copy of this collection, that is, a collection with identical elements which does not change if this collection changes. If this collection is immutable, it is acceptable to return a reference to this collection. If this collection is mutable, a newly instantiated collection must be returned.

Refines MutableList.clone ultimately refines Collection.clone
deleteSource Codeshared actual Value delete(Integer index)

Remove the element at the specified index, returning the removed element, if any, or null if there was no such element.

Refines MutableList.delete ultimately refines ListMutator.delete
deleteMeasureSource Codeshared actual void deleteMeasure(Integer from, Integer length)

Remove every element with an index in the measured range from:length.

Refines ListMutator.deleteMeasure
deleteSpanSource Codeshared actual void deleteSpan(Integer from, Integer to)

Remove every element with an index in the spanned range from..to.

Refines ListMutator.deleteSpan
equalsSource Codeshared actual Boolean equals(LangObject that)

Determine if two values are equal. Implementations should respect the constraints that:

  • if x===y then x==y (reflexivity),
  • if x==y then y==x (symmetry),
  • if x==y and y==z then x==z (transitivity).

Furthermore it is recommended that implementations ensure that if x==y then x and y have the same concrete class.

A class which explicitly refines equals() is said to support value equality, and the equality operator == is considered much more meaningful for such classes than for a class which simply inherits the default implementation of identity equality from Identifiable.

Note that an implementation of equals() that always returns false does satisfy the constraints given above. Therefore, in very rare cases where there is no reasonable definition of value equality for a class, for example, function references (Callable), it is acceptable for equals() to be defined to return false for every argument.

Refines Identifiable.equals ultimately refines Object.equals
getFromFirstSource Codeshared actual Value getFromFirst(Integer index)

The indexth element returned by an iterator of this stream, or null if there are fewer than index+1 elements in the stream. For a stream with an unstable iteration order, a different value might be produced each time getFromFirst(index) is called for a given integer index.

Refines List.getFromFirst ultimately refines Iterable.getFromFirst
infillSource Codeshared actual void infill(Value replacement)

Replace all null values in this list with the given replacement value.

Refines ListMutator.infill
insertSource Codeshared actual void insert(Integer index, Value val)

Insert the given element at the specified index, incrementing the length of the list.

Refines ListMutator.insert
insertAllSource Codeshared actual void insertAll(Integer index, {Value*} elements)

Insert the given elements at the specified index, growing the length of the list by the number of given elements.

Refines ListMutator.insertAll
iteratorSource Codeshared actual Iterator<Value> iterator()

An iterator for the elements belonging to this stream.

Refines List.iterator ultimately refines Iterable.iterator
measureSource Codeshared actual Array measure(Integer from, Integer length)

Obtain a measure containing the mapped values starting from the given starting index (from), with the given length. If length<=0, the resulting measure is empty.

The measure should contain the given number (length) of elements of this stream, starting from the element at the given starting index (from), in the same order as they are produced by the iterator of the stream. In the case where the iterator would be exhausted before length elements are produced, the resulting measure contains only those elements which were produced before the iterator was exhausted, and the length of the measure is less then the given length.

When the given index does not belong to this ranged object, the behavior is implementation dependent.

Refines List.measure ultimately refines Ranged.measure
pruneSource Codeshared actual void prune()

Remove all null elements from this list, leaving a list with no null elements.

Refines ListMutator.prune
removeSource Codeshared actual Integer remove(ObjectValue val)

Remove all occurrences of the given value from this list, returning the number of elements removed.

To remove just one occurrence of the given value, use ListMutator.removeFirst() or ListMutator.removeLast().

Refines ListMutator.remove
removeAllSource Codeshared actual Integer removeAll({ObjectValue*} elements)

Remove all occurrences of every one of the given values from this list, returning the number of elements removed.

Refines ListMutator.removeAll
removeFirstSource Codeshared actual Boolean removeFirst(ObjectValue element)

Remove the first occurrence of the given value from this list, if any, returning true if the value occurs in the list, or false otherwise.

Refines ListMutator.removeFirst
removeLastSource Codeshared actual Boolean removeLast(ObjectValue element)

Remove the last occurrence of the given value from this list, if any, returning true if the value occurs in the list, or false otherwise.

Refines ListMutator.removeLast
replaceSource Codeshared actual void replace(ObjectValue val, Value newVal)

Replace all occurrences of the given value in this list with the given replacement value.

To replace just one occurrence of the given value, use ListMutator.replaceFirst() or ListMutator.replaceLast().

Refines ListMutator.replace
replaceFirstSource Codeshared actual Boolean replaceFirst(ObjectValue element, Value replacement)

Replace the first occurrence of the given value in this list, if any, with the given replacement value, returning true if the value occurs in the list, or false otherwise.

Refines ListMutator.replaceFirst
replaceLastSource Codeshared actual Boolean replaceLast(ObjectValue element, Value replacement)

Replace the last occurrence of the given value in this list, if any, with the given replacement value, returning true if the value occurs in the list, or false otherwise.

Refines ListMutator.replaceLast
setSource Codeshared actual void set(Integer index, Value val)

Replace the existing element at the specified index with the given element.

Refines ListMutator.set
spanSource Codeshared actual Array span(Integer from, Integer to)

Obtain a span containing the elements between the two given indices.

The span should contain elements of this stream, starting from the element at the given starting index (from), and ending with the element at the given ending index (to), in the same order as they are produced by the iterator of the stream, except when the ending index occurs earlier than the starting index, in which case they occur in the opposite order.

When one or both of the given indices does not belong to this ranged stream, the behavior is implementation dependent.

Refines List.span ultimately refines Ranged.span
spanFromSource Codeshared actual Array spanFrom(Integer from)

Obtain a span containing the elements between the given starting index (from) and the last index of this ranged object.

The span should contain elements of this stream, starting from the element at the given starting index (from), in the same order as they are produced by the iterator of the stream.

When the given index does not belong to this ranged stream, the behavior is implementation dependent.

Refines List.spanFrom ultimately refines Ranged.spanFrom
spanToSource Codeshared actual Array spanTo(Integer to)

Obtain a span containing the elements between the first index of this ranged stream and given end index (to).

The span should contain elements of this stream, up to the element at the given ending index (to), in the same order as they are produced by the iterator of the stream.

When the given index does not belong to this ranged stream, the behavior is implementation dependent.

Refines List.spanTo ultimately refines Ranged.spanTo
truncateSource Codeshared actual void truncate(Integer size)

Truncate this list to the given size by removing elements from the end of the list, if necessary, to leave a list with at most the given size.

Refines ListMutator.truncate
Inherited Methods
Methods inherited from: LangObject
equals()
Methods inherited from: Category<Element>
contains(), containsAny(), containsEvery()
Methods inherited from: Collection<Element>
clone(), contains()
Methods inherited from: Correspondence<Key,Item>
defines(), definesAny(), definesEvery(), get(), getAll()
Methods inherited from: Iterable<Element,Absent>
any(), by(), chain(), collect(), contains(), count(), defaultNullElements(), each(), every(), filter(), find(), findLast(), flatMap(), fold(), follow(), frequencies(), getFromFirst(), group(), indexes(), interpose(), iterator(), locate(), locateLast(), locations(), longerThan(), map(), max(), narrow(), partition(), product(), reduce(), repeat(), scan(), select(), sequence(), shorterThan(), skip(), skipWhile(), sort(), spread(), summarize(), tabulate(), take(), takeWhile()
Methods inherited from: List<Element>
clone(), collect(), contains(), defines(), endsWith(), equals(), find(), findLast(), firstIndexWhere(), get(), getFromFirst(), getFromLast(), indexesWhere(), initial(), iterator(), lastIndexWhere(), longerThan(), measure(), patch(), repeat(), shorterThan(), slice(), span(), spanFrom(), spanTo(), startsWith(), sublist(), sublistFrom(), sublistTo(), terminal(), trim(), trimLeading(), trimTrailing()
Methods inherited from: ListMutator<Element>
add(), addAll(), clear(), clone(), delete(), deleteFirst(), deleteLast(), deleteMeasure(), deleteSpan(), infill(), insert(), insertAll(), move(), prune(), remove(), removeAll(), removeFirst(), removeLast(), replace(), replaceFirst(), replaceLast(), set(), swap(), truncate()
Methods inherited from: MutableList<Element>
clone(), delete(), deleteFirst(), deleteLast(), move(), swap()
Methods inherited from: Ranged<Index,Element,Subrange>
measure(), span(), spanFrom(), spanTo()