Package coneforest.psylla.core

Class PsyDict

java.lang.Object

coneforest.psylla.core.PsyDict

All Implemented Interfaces:

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

Direct Known Subclasses:

PsyModule, PsyNamespace

public class PsyDict
extends Object
implements PsyFormalDict<PsyObject>

A representation of Ψ-dict, a dictionary.

Field Summary

Fields

Modifier and Type	Field	Description
static PsyOperator[]	OPERATORS

Constructor Summary

Constructors

Constructor	Description
PsyDict()	Creates a new empty Ψ-dict.
PsyDict(HashMap<String,PsyObject> dict)	Creates a new Ψ-dict wrapped around the given hash map.

Method Summary

Modifier and Type	Method	Description
PsyObject	get(String key)
boolean	isEmpty()	Returns a boolean indicating if this container is empty (has zero length).
Iterator<PsyObject>	iterator()
boolean	known(String key)
int	length()	Returns a length of this object.
void	psyClear()	Clear this object.
PsyDict	psyClone()	Returns a clone of this object.
PsyStream	psyKeys()	Returns a Ψ-iterable enumeration of all the keys of this object.
PsyDict	psySlice(PsyIterable<PsyTextual> oKeys)	Returns a container of the same type as this object consisting of keys or indices from given Ψ-iterable and of associated values.
PsyStream	psyStream()
void	put(String key, PsyObject o)
void	undef(String key)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty

Methods inherited from interface coneforest.psylla.core.PsyFormalDict

psyDelete, psyEntries, psyExtract, psyForAll, psyGet, psyGetAll, psyKnown, psyPut, psyUndef, toSyntaxString, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyIndexed

psyValues

Methods inherited from interface coneforest.psylla.core.PsyIterable

psyToArray, psyUnite

Methods inherited from interface coneforest.psylla.core.PsyLengthy

psyIsEmpty, psyLength

Methods inherited from interface coneforest.psylla.core.PsyObject

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

Field Detail

OPERATORS

public static final PsyOperator[] OPERATORS

Constructor Detail

PsyDict

public PsyDict()

Creates a new empty Ψ-dict.

PsyDict

public PsyDict(HashMap<String,PsyObject> dict)

Creates a new Ψ-dict wrapped around the given hash map.

Parameters:

dict - a given hash map.

Method Detail

psyClone

public PsyDict psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object.

get

public PsyObject get(String key)
              throws PsyException

Specified by:

get in interface PsyFormalDict<PsyObject>

Throws:

PsyException

put

public void put(String key,
                PsyObject o)

Specified by:

put in interface PsyFormalDict<PsyObject>

undef

public void undef(String key)

Specified by:

undef in interface PsyFormalDict<PsyObject>

known

public boolean known(String key)

Specified by:

known in interface PsyFormalDict<PsyObject>

iterator

public Iterator<PsyObject> iterator()

Specified by:

iterator in interface Iterable<PsyObject>

length

public int length()

Description copied from interface: PsyLengthy

Returns a length of this object.

Specified by:

length in interface PsyLengthy

Returns:

a length.

isEmpty

public boolean isEmpty()

Description copied from interface: PsyLengthy

Returns a boolean indicating if this container is empty (has zero length).

Specified by:

isEmpty in interface PsyLengthy

Returns:

true, if this container is empty, and false otherwise.

psyClear

public void psyClear()

Description copied from interface: PsyClearable

Clear this object.

Specified by:

psyClear in interface PsyClearable

Specified by:

psyClear in interface PsyFormalDict<PsyObject>

psySlice

public PsyDict psySlice(PsyIterable<PsyTextual> oKeys)
                 throws PsyException

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 PsyFormalDict<PsyObject>

Specified by:

psySlice in interface PsyIndexed<PsyTextual,PsyObject>

Parameters:

oKeys - an enumeration of keys.

Returns:

a container.

Throws:

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

psyKeys

public PsyStream psyKeys()

Description copied from interface: PsyIndexed

Returns a Ψ-iterable enumeration of all the keys of this object.

Specified by:

psyKeys in interface PsyFormalDict<PsyObject>

Specified by:

psyKeys in interface PsyIndexed<PsyTextual,PsyObject>

Returns:

an enumeration of keys.

psyStream

public PsyStream psyStream()

Specified by:

psyStream in interface PsyIterable<PsyObject>

Specified by:

psyStream in interface PsyStreamable<PsyObject>