com.github.jlangch.venice.impl.util

Class CallStack

java.lang.Object

com.github.jlangch.venice.impl.util.CallStack

public class CallStack
extends java.lang.Object

Defines a call stack for function calls that represents the nested order of function calls

Constructor Summary

Constructors

Constructor and Description
CallStack()

Method Summary

Modifier and Type	Method and Description
java.util.List<CallFrame>	callstack() Returns a list of call frames in this call stack.
void	clear() Removes all of the elements from this call stack.
CallStack	copy()
boolean	isEmpty() Returns true if this call stack contains no elements.
CallFrame	peek() Retrieves, but does not remove, the head of the call stack or returns null if this call stack is empty.
CallFrame	pop() Pops an frame from the call stack.
void	push(CallFrame frame) Pushes a frame onto the call stack.
java.util.List<java.lang.String>	toList() Returns a list of stringified call frames in this call stack.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CallStack

public CallStack()

Method Detail

push

public void push(CallFrame frame)

Pushes a frame onto the call stack.

Parameters:

frame - the frame to push

Throws:

java.lang.NullPointerException - if the specified frame is null

pop

public CallFrame pop()

Pops an frame from the call stack.

Returns:

the head of this call stack, or null if this if this call stack is empty

peek

public CallFrame peek()

Retrieves, but does not remove, the head of the call stack or returns null if this call stack is empty.

Returns:

the head of this call stack, or null if this if this call stack is empty

isEmpty

public boolean isEmpty()

Returns true if this call stack contains no elements.

Returns:

true if this call stack contains no elements

clear

public void clear()

Removes all of the elements from this call stack. The call stack will be empty after this call returns.

copy

public CallStack copy()

Returns:

a copy of this call stack

toList

public java.util.List<java.lang.String> toList()

Returns a list of stringified call frames in this call stack. The elements will be ordered from first (head) to last (tail). This is the same order that elements would be dequeued (via successive calls to pop()). The head element will be stored at index 0 in the list.

Returns:

a list of stringified call frames in this call stack

callstack

public java.util.List<CallFrame> callstack()

Returns a list of call frames in this call stack. The elements will be ordered from first (head) to last (tail). This is the same order that elements would be dequeued (via successive calls to pop()). The head element will be stored at index 0 in the list.

Returns:

a list ofcall frames in this call stack

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object