Module coneforest.psylla

Package coneforest.psylla.core

Class PsyDict

java.lang.Object

coneforest.psylla.core.PsyDict

All Implemented Interfaces:

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

Direct Known Subclasses:

PsyModule, PsyNamespace

@Type("dict")
public class PsyDict
extends Object
implements PsyFormalDict<PsyObject>

The representation of dict, a dictionary.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_DICT	Context action of the dict operator.
static final ContextAction	PSY_DICTTOMARK	Context action of the dicttomark operator.

Fields inherited from interface coneforest.psylla.core.PsyClearable

PSY_CLEAR

Fields inherited from interface coneforest.psylla.core.PsyFormalDict

PSY_UNDEF

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

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()
Stream<String>	keys()
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.
PsyDict	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.
PsyFormalStream<PsyObject>	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, psyKeys, psyKnown, psyPut, psyUndef, toSyntaxString, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyIndexed

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

Field Details

PSY_DICT

@OperatorType("dict")
public static final ContextAction PSY_DICT

Context action of the dict operator.

PSY_DICTTOMARK

@OperatorType("dicttomark")
public static final ContextAction PSY_DICTTOMARK

Context action of the dicttomark operator.

Constructor Details

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 Details

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 PsyUndefinedException

Specified by:

get in interface PsyFormalDict<PsyObject>

Throws:

PsyUndefinedException

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 of this object

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:

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

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

Specified by:

psySlice in interface PsyIndexed<PsyString,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.

keys

public Stream<String> keys()

Specified by:

keys in interface PsyFormalDict<PsyObject>

psyStream

public PsyFormalStream<PsyObject> psyStream()

Specified by:

psyStream in interface PsyIterable<PsyObject>

Specified by:

psyStream in interface PsyStreamable<PsyObject>