Package coneforest.psylla.core

Interface PsyFormalDict<V extends PsyObject>

Type Parameters:

V - a type of contained values.

All Superinterfaces:

Iterable<V>, PsyClearable, PsyContainer<V>, PsyConvertableToName, PsyConvertableToString, PsyIndexed<PsyTextual,V>, PsyIterable<V>, PsyLengthy, PsyObject, PsySequential<V>, PsyStreamable<V>

All Known Implementing Classes:

PsyConfigDict, PsyDict, PsyErrorDict, PsyModule, PsyNamespace, PsyRomanNumerals, PsySystemDict

public interface PsyFormalDict<V extends PsyObject>
extends PsyContainer<V>, PsyIndexed<PsyTextual,V>, PsySequential<V>

A representation of formaldict, an abstraction of a dictionary.

Field Summary

Fields

Modifier and Type	Field	Description
static PsyOperator[]	OPERATORS

Method Summary

Modifier and Type	Method	Description
V	get(String key)
boolean	known(String key)
default void	psyClear()	Clear this object.
default void	psyDelete(PsyTextual oKey)	Deletes a key or index and a value associated with it from this object.
default PsyStream	psyEntries()	Returns an iterable enumeration of all the keys and values of this object.
default V	psyExtract(PsyTextual oKey)
default void	psyForAll(PsyObject oProc, PsyContext oContext)
default V	psyGet(PsyTextual oKey)	Returns the element with given key or index.
default PsyFormalArray<V>	psyGetAll(PsyIterable<PsyTextual> oEnumeration)
PsyFormalStream<PsyTextual>	psyKeys()	Returns an iterable enumeration of all the keys of this object.
default PsyBoolean	psyKnown(PsyTextual oKey)	Returns a boolean indicating whether given key or index exists in this object.
default void	psyPut(PsyTextual oKey, V oValue)	Stores an element with given key or index.
PsyFormalDict<V>	psySlice(PsyIterable<PsyTextual> oEnumeration)	Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.
default void	psyUndef(PsyTextual oKey)	Deletes a key and associated value from this dictionary.
void	put(String key, V oValue)
default String	toSyntaxString()
default String	toSyntaxStringHelper(Set<PsyContainer<V>> processed)
void	undef(String key)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty

Methods inherited from interface coneforest.psylla.core.PsyIndexed

psyValues

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, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, typeName

Field Detail

OPERATORS

static final PsyOperator[] OPERATORS

Method Detail

psyForAll

default void psyForAll(PsyObject oProc,
                       PsyContext oContext)
                throws PsyErrorException

Specified by:

psyForAll in interface PsySequential<V extends PsyObject>

Specified by:

psyForAll in interface PsyStreamable<V extends PsyObject>

Throws:

PsyErrorException

get

V get(String key)
throws PsyErrorException

Throws:

PsyErrorException

psyGet

default V psyGet(PsyTextual oKey)
          throws PsyErrorException

Description copied from interface: PsyIndexed

Returns the element with given key or index.

Specified by:

psyGet in interface PsyIndexed<PsyTextual,V extends PsyObject>

Parameters:

oKey - a key or an index.

Returns:

an element.

Throws:

PsyErrorException - when index is out of range.

psyGetAll

default PsyFormalArray<V> psyGetAll(PsyIterable<PsyTextual> oEnumeration)
                             throws PsyErrorException

Specified by:

psyGetAll in interface PsyIndexed<PsyTextual,V extends PsyObject>

Throws:

PsyErrorException

put

void put(String key,
         V oValue)

psyPut

default void psyPut(PsyTextual oKey,
                    V oValue)

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<PsyTextual,V extends PsyObject>

Parameters:

oKey - a key or an index.

oValue - an element to be stored.

known

boolean known(String key)

psyKnown

default PsyBoolean psyKnown(PsyTextual oKey)

Description copied from interface: PsyIndexed

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

Specified by:

psyKnown in interface PsyIndexed<PsyTextual,V extends PsyObject>

Parameters:

oKey - a key or an index.

Returns:

a result.

undef

void undef(String key)

psyUndef

default void psyUndef(PsyTextual oKey)

Deletes a key and associated value from this dictionary.

Parameters:

oKey - a textual key.

psyKeys

PsyFormalStream<PsyTextual> psyKeys()

Description copied from interface: PsyIndexed

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

Specified by:

psyKeys in interface PsyIndexed<PsyTextual,V extends PsyObject>

Returns:

an enumeration of keys.

psyDelete

default void psyDelete(PsyTextual oKey)
                throws PsyErrorException

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<PsyTextual,V extends PsyObject>

Parameters:

oKey - a key or an index.

Throws:

PsyErrorException - when key is absent or index is out of range.

psyExtract

default V psyExtract(PsyTextual oKey)
              throws PsyErrorException

Specified by:

psyExtract in interface PsyIndexed<PsyTextual,V extends PsyObject>

Throws:

PsyErrorException

psySlice

PsyFormalDict<V> psySlice(PsyIterable<PsyTextual> oEnumeration)
                   throws PsyErrorException

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<PsyTextual,V extends PsyObject>

Parameters:

oEnumeration - an enumeration of keys.

Returns:

a container.

Throws:

PsyErrorException - when key is absent or index is out of range.

psyEntries

default PsyStream 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<PsyTextual,V extends PsyObject>

Returns:

an enumeration of entries.

toSyntaxString

default String toSyntaxString()

Specified by:

toSyntaxString in interface PsyObject

toSyntaxStringHelper

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

Specified by:

toSyntaxStringHelper in interface PsyContainer<V extends PsyObject>

psyClear

default void psyClear()

Description copied from interface: PsyClearable

Clear this object.

Specified by:

psyClear in interface PsyClearable