Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyFormalArray<T extends PsyObject>

Type Parameters:

T - a type of contained objects.

All Superinterfaces:

Iterable<T>, PsyAppendable<T>, PsyClearable, PsyContainer<T>, PsyIndexed<PsyInteger,T>, PsyIterable<T>, PsyLengthy, PsyObject, PsySequential<T>, PsyStreamable<T>

All Known Implementing Classes:

PsyArray, PsyBitArray, PsyProc, PsyString

@Type("formalarray")
public interface PsyFormalArray<T extends PsyObject>
extends PsyAppendable<T>, PsyContainer<T>, PsyIndexed<PsyInteger,T>, PsySequential<T>

The representation of formalarray, an abstraction of an array composed of objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_EXTRACTINTERVAL	Context action of the extractinterval operator.
static final ContextAction	PSY_GETINTERVAL	Context action of the getinterval operator.
static final ContextAction	PSY_INSERT	Context action of the insert operator.
static final ContextAction	PSY_INSERTALL	Context action of the insertall operator.
static final ContextAction	PSY_POSTCHOP	Context action of the postchop operator.
static final ContextAction	PSY_PRECHOP	Context action of the prechop operator.
static final ContextAction	PSY_PREPEND	Context action of the prepend operator.
static final ContextAction	PSY_PREPENDALL	Context action of the prependall operator.
static final ContextAction	PSY_PUTINTERVAL	Context action of the putinterval operator.
static final ContextAction	PSY_REVERSE	Context action of the reverse operator.
static final ContextAction	PSY_SETLENGTH	Context action of the setlength operator.

Fields inherited from interface coneforest.psylla.core.PsyAppendable

PSY_APPEND, PSY_APPENDALL

Fields inherited from interface coneforest.psylla.core.PsyClearable

PSY_CLEAR

Fields inherited from interface coneforest.psylla.core.PsyIndexed

PSY_DELETE, PSY_ENTRIES, PSY_EXTRACT, PSY_GET, PSY_GETALL, PSY_KEYS, PSY_KNOWN, PSY_PUT, PSY_SLICE, PSY_VALUES

Fields inherited from interface coneforest.psylla.core.PsyLengthy

PSY_ISEMPTY, PSY_LENGTH

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TONAME, PSY_TOSTRING, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsySequential

PSY_FORALL

Fields inherited from interface coneforest.psylla.core.PsyStreamable

PSY_STREAM

Method Summary

Modifier and Type	Method	Description
void	delete(int index)	Removes the element at the specified position in this array.
T	extract(int index)
T	get(int index)	Returns the element at the specified position in this array.
void	insert(int index, T o)	Inserts the specified object into this array at the position specified by a given index.
PsyFormalArray<T>	psyClone()	Returns a clone of this object.
default void	psyDelete(PsyInteger oIndex)	Deletes a key or index and a value associated with it from this object.
default PsyFormalStream<PsyObject>	psyEntries()	Returns an iterable enumeration of all the keys and values of this object.
default T	psyExtract(PsyInteger oIndex)
PsyFormalArray<T>	psyExtractInterval(PsyInteger oIndex, PsyInteger oCount)
default T	psyGet(PsyInteger oIndex)	Returns the element with given key or index.
PsyFormalArray<T>	psyGetInterval(PsyInteger oIndex, PsyInteger oLength)
default void	psyInsert(PsyInteger oIndex, T o)	Inserts the specified object into this array at the position specified by a given integer index.
default void	psyInsertAll(PsyInteger oIndex, PsyIterable<? extends T> oEnumeration)
default PsyStream	psyKeys()	Returns an iterable enumeration of all the keys of this object.
default PsyBoolean	psyKnown(PsyInteger oIndex)	Returns a boolean indicating whether given key or index exists in this object.
default T	psyPostChop()
default T	psyPreChop()
default void	psyPrepend(T o)	Inserts the specified object into this array at the beginning.
default void	psyPrependAll(PsyIterable<? extends T> oEnumeration)
default void	psyPut(PsyInteger oIndex, T o)	Stores an element with given key or index.
default void	psyPutInterval(PsyInteger oIndex, PsyIterable<? extends T> oEnumeration)
default PsyFormalArray<T>	psyReplicate(PsyInteger oCount)
default PsyFormalArray<T>	psyReverse()
void	psySetLength(PsyInteger oLength)
PsyFormalArray<T>	psySlice(PsyIterable<PsyInteger> oIndices)	Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.
default PsyFormalStream<T>	psyValues()	Returns an iterable enumeration of all the values of this object.
void	put(int index, T o)
default String	toSyntaxString()	Returns the syntactic representation of this object.
default String	toSyntaxStringHelper(Set<PsyContainer<T>> processed)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface coneforest.psylla.core.PsyAppendable

psyAppend, psyAppendAll

Methods inherited from interface coneforest.psylla.core.PsyClearable

psyClear

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty

Methods inherited from interface coneforest.psylla.core.PsyIndexed

psyGetAll

Methods inherited from interface coneforest.psylla.core.PsyIterable

psyStream, psyToArray, psyUnite

Methods inherited from interface coneforest.psylla.core.PsyLengthy

isEmpty, length, psyIsEmpty, psyLength

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, typeName

Methods inherited from interface coneforest.psylla.core.PsyStreamable

psyForAll

Field Details

PSY_EXTRACTINTERVAL

@OperatorType("extractinterval")
static final ContextAction PSY_EXTRACTINTERVAL

Context action of the extractinterval operator.

PSY_GETINTERVAL

@OperatorType("getinterval")
static final ContextAction PSY_GETINTERVAL

Context action of the getinterval operator.

PSY_INSERT

@OperatorType("insert")
static final ContextAction PSY_INSERT

Context action of the insert operator.

PSY_INSERTALL

@OperatorType("insertall")
static final ContextAction PSY_INSERTALL

Context action of the insertall operator.

PSY_POSTCHOP

@OperatorType("postchop")
static final ContextAction PSY_POSTCHOP

Context action of the postchop operator.

PSY_PRECHOP

@OperatorType("prechop")
static final ContextAction PSY_PRECHOP

Context action of the prechop operator.

PSY_PREPEND

@OperatorType("prepend")
static final ContextAction PSY_PREPEND

Context action of the prepend operator.

PSY_PREPENDALL

@OperatorType("prependall")
static final ContextAction PSY_PREPENDALL

Context action of the prependall operator.

PSY_PUTINTERVAL

@OperatorType("putinterval")
static final ContextAction PSY_PUTINTERVAL

Context action of the putinterval operator.

PSY_REVERSE

@OperatorType("reverse")
static final ContextAction PSY_REVERSE

Context action of the reverse operator.

PSY_SETLENGTH

@OperatorType("setlength")
static final ContextAction PSY_SETLENGTH

Context action of the setlength operator.

Method Details

psyClone

PsyFormalArray<T> psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object.

psyReverse

default PsyFormalArray<T> psyReverse()
                              throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyKnown

default PsyBoolean psyKnown(PsyInteger oIndex)

Description copied from interface: PsyIndexed

Returns a boolean indicating whether given key or index exists in this object.

Specified by:

psyKnown in interface PsyIndexed<PsyInteger,T extends PsyObject>

Parameters:

oIndex - a key or an index.

Returns:

a result.

get

T get(int index)
throws PsyRangeCheckException

Returns the element at the specified position in this array.

Parameters:

index - the index of the element.

Returns:

the element at the specified position in this list.

Throws:

PsyRangeCheckException - if the index is out of range.

psyGet

default T psyGet(PsyInteger oIndex)
          throws PsyRangeCheckException

Description copied from interface: PsyIndexed

Returns the element with given key or index.

Specified by:

psyGet in interface PsyIndexed<PsyInteger,T extends PsyObject>

Parameters:

oIndex - a key or an index.

Returns:

an element.

Throws:

PsyRangeCheckException - when index is out of range.

psyGetInterval

PsyFormalArray<T> psyGetInterval(PsyInteger oIndex,
 PsyInteger oLength)
                          throws PsyRangeCheckException

Throws:

PsyRangeCheckException

put

void put(int index,
 T o)
  throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyPut

default void psyPut(PsyInteger oIndex,
 T o)
             throws PsyRangeCheckException

Description copied from interface: PsyIndexed

Stores an element with given key or index. In PsyFormalArray containers replaces existing element. In PsyFormalDict containers replaces an old or creates a new element associated with specified key.

Specified by:

psyPut in interface PsyIndexed<PsyInteger,T extends PsyObject>

Parameters:

oIndex - a key or an index.

o - an element to be stored.

Throws:

PsyRangeCheckException - when the index is out of range.

insert

void insert(int index,
 T o)
     throws PsyRangeCheckException

Inserts the specified object into this array at the position specified by a given index.

Parameters:

index - a integer index.

o - a object.

Throws:

PsyRangeCheckException - when TODO.

psyInsert

default void psyInsert(PsyInteger oIndex,
 T o)
                throws PsyRangeCheckException

Inserts the specified object into this array at the position specified by a given integer index.

Parameters:

oIndex - an integer index.

o - an object.

Throws:

PsyRangeCheckException - when TODO.

psyInsertAll

default void psyInsertAll(PsyInteger oIndex,
 PsyIterable<? extends T> oEnumeration)
                   throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyPrepend

default void psyPrepend(T o)
                 throws PsyRangeCheckException

Inserts the specified object into this array at the beginning.

Parameters:

o - an object.

Throws:

PsyRangeCheckException - when TODO.

psyPreChop

default T psyPreChop()
              throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyPostChop

default T psyPostChop()
               throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyPrependAll

default void psyPrependAll(PsyIterable<? extends T> oEnumeration)
                    throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyReplicate

default PsyFormalArray<T> psyReplicate(PsyInteger oCount)
                                throws PsyLimitCheckException,
PsyRangeCheckException,
PsyUnsupportedException

Specified by:

psyReplicate in interface PsyAppendable<T extends PsyObject>

Throws:

PsyLimitCheckException

PsyRangeCheckException

PsyUnsupportedException

psyPutInterval

default void psyPutInterval(PsyInteger oIndex,
 PsyIterable<? extends T> oEnumeration)
                     throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyDelete

default void psyDelete(PsyInteger oIndex)
                throws PsyRangeCheckException

Description copied from interface: PsyIndexed

Deletes a key or index and a value associated with it from this object.

Specified by:

psyDelete in interface PsyIndexed<PsyInteger,T extends PsyObject>

Parameters:

oIndex - a key or an index.

Throws:

PsyRangeCheckException - when the index is out of range.

delete

void delete(int index)
     throws PsyRangeCheckException

Removes the element at the specified position in this array.

Parameters:

index - the index of the element to be removed.

Throws:

PsyRangeCheckException - if the index is out of range.

psyExtract

default T psyExtract(PsyInteger oIndex)
              throws PsyRangeCheckException

Specified by:

psyExtract in interface PsyIndexed<PsyInteger,T extends PsyObject>

Throws:

PsyRangeCheckException

psySetLength

void psySetLength(PsyInteger oLength)
           throws PsyLimitCheckException,
PsyRangeCheckException

Throws:

PsyLimitCheckException

PsyRangeCheckException

extract

T extract(int index)
   throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psyExtractInterval

PsyFormalArray<T> psyExtractInterval(PsyInteger oIndex,
 PsyInteger oCount)
                              throws PsyRangeCheckException

Throws:

PsyRangeCheckException

psySlice

PsyFormalArray<T> psySlice(PsyIterable<PsyInteger> oIndices)
                    throws PsyRangeCheckException,
PsyLimitCheckException,
PsyUnsupportedException

Description copied from interface: PsyIndexed

Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.

Specified by:

psySlice in interface PsyIndexed<PsyInteger,T extends PsyObject>

Parameters:

oIndices - an enumeration of keys.

Returns:

a container.

Throws:

PsyRangeCheckException - when the index is out of range.

PsyLimitCheckException - when TODO

PsyUnsupportedException - when TODO

psyKeys

default PsyStream psyKeys()

Description copied from interface: PsyIndexed

Returns an iterable enumeration of all the keys of this object.

Specified by:

psyKeys in interface PsyIndexed<PsyInteger,T extends PsyObject>

Returns:

an enumeration of keys.

psyValues

default PsyFormalStream<T> psyValues()

Description copied from interface: PsyIndexed

Returns an iterable enumeration of all the values of this object.

Specified by:

psyValues in interface PsyIndexed<PsyInteger,T extends PsyObject>

Returns:

an enumeration of values.

psyEntries

default PsyFormalStream<PsyObject> psyEntries()

Description copied from interface: PsyIndexed

Returns an iterable enumeration of all the keys and values of this object.

Specified by:

psyEntries in interface PsyIndexed<PsyInteger,T extends PsyObject>

Returns:

an enumeration of entries.

toSyntaxString

default String toSyntaxString()

Description copied from interface: PsyObject

Returns the syntactic representation of this object.

Specified by:

toSyntaxString in interface PsyObject

Returns:

the syntactic representation of this object.

toSyntaxStringHelper

default String toSyntaxStringHelper(Set<PsyContainer<T>> processed)

Specified by:

toSyntaxStringHelper in interface PsyContainer<T extends PsyObject>