Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyIndexed<K extends PsyObject,V extends PsyObject>

Type Parameters:

K - a type of keys or indices.

V - a type of elements.

All Superinterfaces:

PsyObject

All Known Subinterfaces:

PsyFormalArray<T>, PsyFormalDict<V>

All Known Implementing Classes:

PsyArray, PsyBitArray, PsyConfigDict, PsyDict, PsyEnvironment, PsyModule, PsyNamespace, PsyProc, PsyStringBuffer, PsySystemDict

@Type("indexed")
public interface PsyIndexed<K extends PsyObject,V extends PsyObject>
extends PsyObject

The representation of indexed, a type of the container whose elements are indexed.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_DELETE	Context action of the delete operator.
static final ContextAction	PSY_ENTRIES	Context action of the entries operator.
static final ContextAction	PSY_EXTRACT	Context action of the extract operator.
static final ContextAction	PSY_GET	Context action of the get operator.
static final ContextAction	PSY_GETALL	Context action of the getall operator.
static final ContextAction	PSY_KEYS	Context action of the keys operator.
static final ContextAction	PSY_KNOWN	Context action of the known operator.
static final ContextAction	PSY_PUT	Context action of the put operator.
static final ContextAction	PSY_SLICE	Context action of the slice operator.
static final ContextAction	PSY_VALUES	Context action of the values operator.

Fields inherited from interface coneforest.psylla.core.PsyObject

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

Method Summary

Modifier and Type	Method	Description
void	psyDelete(K oKey)	Deletes a key or index and a value associated with it from this object.
PsyFormalStream<PsyObject>	psyEntries()	Returns an iterable enumeration of all the keys and values of this object.
V	psyExtract(K oKey)
V	psyGet(K oKey)	Returns the element with given key or index.
default PsyIterable<V>	psyGetAll(PsyIterable<K> oKeys)
PsyFormalStream<K>	psyKeys()	Returns an iterable enumeration of all the keys of this object.
PsyBoolean	psyKnown(K oKey)	Returns a boolean indicating whether given key or index exists in this object.
void	psyPut(K oKey, V oValue)	Stores an element with given key or index.
PsyIndexed<K,V>	psySlice(PsyIterable<K> oKeys)	Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.
default PsyFormalStream<V>	psyValues()	Returns an iterable enumeration of all the values of this object.

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToString, psyToStringBuffer, psyType, toSyntaxString, typeName

Field Details

PSY_DELETE

@OperatorType("delete")
static final ContextAction PSY_DELETE

Context action of the delete operator.

PSY_ENTRIES

@OperatorType("entries")
static final ContextAction PSY_ENTRIES

Context action of the entries operator.

PSY_EXTRACT

@OperatorType("extract")
static final ContextAction PSY_EXTRACT

Context action of the extract operator.

PSY_GET

@OperatorType("get")
static final ContextAction PSY_GET

Context action of the get operator.

PSY_GETALL

@OperatorType("getall")
static final ContextAction PSY_GETALL

Context action of the getall operator.

PSY_KEYS

@OperatorType("keys")
static final ContextAction PSY_KEYS

Context action of the keys operator.

PSY_KNOWN

@OperatorType("known")
static final ContextAction PSY_KNOWN

Context action of the known operator.

PSY_PUT

@OperatorType("put")
static final ContextAction PSY_PUT

Context action of the put operator.

PSY_SLICE

@OperatorType("slice")
static final ContextAction PSY_SLICE

Context action of the slice operator.

PSY_VALUES

@OperatorType("values")
static final ContextAction PSY_VALUES

Context action of the values operator.

Method Details

psyKnown

PsyBoolean psyKnown(K oKey)

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

Parameters:

oKey - a key or an index.

Returns:

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

psyGet

V psyGet(K oKey)
  throws PsyRangeCheckException,
PsyUndefinedException

Returns the element with given key or index.

Parameters:

oKey - a key or an index.

Returns:

the element with given key or index

Throws:

PsyRangeCheckException - when index is out of range.

PsyUndefinedException - when the key is absent.

psyPut

void psyPut(K oKey,
 V oValue)
     throws PsyRangeCheckException

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.

Parameters:

oKey - a key or an index.

oValue - an element to be stored.

Throws:

PsyRangeCheckException - when the index is out of range.

psyDelete

void psyDelete(K oKey)
        throws PsyRangeCheckException,
PsyUndefinedException

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

Parameters:

oKey - a key or an index.

Throws:

PsyRangeCheckException - when the index is out of range.

PsyUndefinedException - when the key is absent.

psyExtract

V psyExtract(K oKey)
      throws PsyRangeCheckException,
PsyUndefinedException

Throws:

PsyRangeCheckException

PsyUndefinedException

psySlice

PsyIndexed<K,V> psySlice(PsyIterable<K> oKeys)
                  throws PsyRangeCheckException,
PsyLimitCheckException,
PsyUndefinedException,
PsyUnsupportedException

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

Parameters:

oKeys - an enumeration of keys.

Returns:

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

Throws:

PsyLimitCheckException - when TODO

PsyRangeCheckException - when the index is out of range.

PsyUndefinedException - when the key is absent.

PsyUnsupportedException - when TODO

psyGetAll

default PsyIterable<V> psyGetAll(PsyIterable<K> oKeys)
                          throws PsyRangeCheckException,
PsyLimitCheckException,
PsyUndefinedException,
PsyUnsupportedException

Throws:

PsyRangeCheckException

PsyLimitCheckException

PsyUndefinedException

PsyUnsupportedException

psyKeys

PsyFormalStream<K> psyKeys()

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

Returns:

an iterable enumeration of all the keys of this object

psyValues

default PsyFormalStream<V> psyValues()

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

Returns:

an iterable enumeration of all the values of this object

psyEntries

PsyFormalStream<PsyObject> psyEntries()

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

Returns:

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