Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyFormalDict<V extends PsyObject>

Type Parameters:

V - a type of contained values.

All Superinterfaces:

Iterable<V>, PsyClearable, PsyContainer<V>, PsyIndexed<PsyString,V>, PsyIterable<V>, PsyLengthy, PsyObject, PsySequential<V>, PsyStreamable<V>

All Known Implementing Classes:

PsyConfigDict, PsyDict, PsyEnvironment, PsyModule, PsyNamespace, PsySystemDict

@Type("formaldict")
public interface PsyFormalDict<V extends PsyObject>
extends PsyContainer<V>, PsyIndexed<PsyString,V>, PsySequential<V>

The representation of formaldict, an abstraction of a dictionary.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_UNDEF	Context action of the undef operator.

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_TOSTRING, PSY_TOSTRINGBUFFER, 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
V	get(String key)
Stream<String>	keys()
boolean	known(String key)
default void	psyClear()	Clear this object.
default void	psyDelete(PsyString 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(PsyString oKey)
default void	psyForAll(PsyObject oProc, PsyContext oContext)
default V	psyGet(PsyString oKey)	Returns the element with given key or index.
default PsyFormalStream<PsyString>	psyKeys()	Returns an iterable enumeration of all the keys of this object.
default PsyBoolean	psyKnown(PsyString oKey)	Returns a boolean indicating whether given key or index exists in this object.
default void	psyPut(PsyString oKey, V oValue)	Stores an element with given key or index.
PsyFormalDict<V>	psySlice(PsyIterable<PsyString> oKeys)	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(PsyString oKey)	Deletes a key and associated value from this dictionary.
void	put(String key, V oValue)
default String	toSyntaxString()	Returns the syntactic representation of this object.
default String	toSyntaxStringHelper(Set<PsyContainer<? extends PsyObject>> 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

psyGetAll, 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, psyToString, psyToStringBuffer, psyType, typeName

Field Details

PSY_UNDEF

@OperatorType("undef")
static final ContextAction PSY_UNDEF

Context action of the undef operator.

Method Details

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 PsyUndefinedException

Throws:

PsyUndefinedException

psyGet

default V psyGet(PsyString oKey)
          throws PsyUndefinedException

Description copied from interface: PsyIndexed

Returns the element with given key or index.

Specified by:

psyGet in interface PsyIndexed<PsyString,V extends PsyObject>

Parameters:

oKey - a key or an index.

Returns:

the element with given key or index

Throws:

PsyUndefinedException - when the key is absent.

put

void put(String key,
 V oValue)

psyPut

default void psyPut(PsyString 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<PsyString,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(PsyString 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<PsyString,V extends PsyObject>

Parameters:

oKey - a key or an index.

Returns:

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

undef

void undef(String key)

psyUndef

default void psyUndef(PsyString oKey)

Deletes a key and associated value from this dictionary.

Parameters:

oKey - a string key.

psyKeys

default PsyFormalStream<PsyString> psyKeys()

Description copied from interface: PsyIndexed

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

Specified by:

psyKeys in interface PsyIndexed<PsyString,V extends PsyObject>

Returns:

an iterable enumeration of all the keys of this object

keys

Stream<String> keys()

psyDelete

default void psyDelete(PsyString oKey)
                throws PsyUndefinedException

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

Parameters:

oKey - a key or an index.

Throws:

PsyUndefinedException - when the key is absent.

psyExtract

default V psyExtract(PsyString oKey)
              throws PsyUndefinedException

Specified by:

psyExtract in interface PsyIndexed<PsyString,V extends PsyObject>

Throws:

PsyUndefinedException

psySlice

PsyFormalDict<V> psySlice(PsyIterable<PsyString> oKeys)
                   throws PsyUndefinedException

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

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:

PsyUndefinedException - when the key is absent.

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

Returns:

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

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<? extends PsyObject>> 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