Class DictStack

java.lang.Object

java.util.AbstractCollection<PsyFormalDict<PsyObject>>

java.util.AbstractList<PsyFormalDict<PsyObject>>

java.util.ArrayList<PsyFormalDict<PsyObject>>

coneforest.psylla.runtime.Stack<PsyFormalDict<PsyObject>>

coneforest.psylla.runtime.DictStack

All Implemented Interfaces:

Serializable, Cloneable, Iterable<PsyFormalDict<PsyObject>>, Collection<PsyFormalDict<PsyObject>>, List<PsyFormalDict<PsyObject>>, RandomAccess, SequencedCollection<PsyFormalDict<PsyObject>>

public final class DictStack
extends Stack<PsyFormalDict<PsyObject>>

An interpreter’s dictionary stack.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DictStack()	Creates a new dictionary stack with two permanent dictionaries in it (system and user dictionaries).

Method Summary

Modifier and Type	Method	Description
void	begin(PsyFormalDict<PsyObject> oDict)	Pushes the dictionary to this stack.
DictStack	clone()
PsyNamespace	currentNamespace()
void	end()	Pops a non-permanent dictionary from this stack.
<T extends PsyObject> T	load(PsyString oKey)	Performs in-depth search for the given string key in this stack and returns the associated value.
<T extends PsyObject> T	load(String key)	Performs in-depth search for the given key in this stack and returns the associated value.
void	store(PsyTextual oKey, PsyObject oValue)
Optional<PsyFormalDict<PsyObject>>	where(String key)	Performs in-depth search for the dictionary containing the given key in this stack and returns an Optional contating the dictionary found or empty Optional if not found.

Methods inherited from class Stack

peek, pop, push, setSize

Methods inherited from class ArrayList

add, add, addAll, addAll, addFirst, addLast, clear, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class AbstractCollection

containsAll, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, stream, toArray

Methods inherited from interface List

containsAll, reversed

Constructor Details

DictStack

public DictStack()
          throws PsyUndefinedException

Creates a new dictionary stack with two permanent dictionaries in it (system and user dictionaries).

Throws:

PsyUndefinedException - when TODO.

Method Details

clone

public DictStack clone()

Overrides:

clone in class ArrayList<PsyFormalDict<PsyObject>>

load

public <T extends PsyObject> T load(String key)
                             throws PsyUndefinedException

Performs in-depth search for the given key in this stack and returns the associated value.

Type Parameters:

T - the type of the value.

Parameters:

key - the key.

Returns:

the associated value.

Throws:

PsyUndefinedException - if the key is not found.

load

public <T extends PsyObject> T load(PsyString oKey)
                             throws PsyUndefinedException

Performs in-depth search for the given string key in this stack and returns the associated value.

Type Parameters:

T - the type of the value.

Parameters:

oKey - the string key.

Returns:

the associated value.

Throws:

PsyUndefinedException - if the key is not found.

where

public Optional<PsyFormalDict<PsyObject>> where(String key)

Performs in-depth search for the dictionary containing the given key in this stack and returns an Optional contating the dictionary found or empty Optional if not found.

Parameters:

key - the key.

Returns:

a Optional containing the dictionary found.

currentNamespace

public PsyNamespace currentNamespace()

store

public void store(PsyTextual oKey,
 PsyObject oValue)

begin

public void begin(PsyFormalDict<PsyObject> oDict)

Pushes the dictionary to this stack.

Parameters:

oDict - the formaldict dictionary.

end

public void end()
         throws PsyDictStackUnderflowException

Pops a non-permanent dictionary from this stack.

Throws:

PsyDictStackUnderflowException - if this stack does not contain non-permanent dictionaries.