com.scriptbasic.syntax

Class AbstractNestedStructureHouseKeeper

java.lang.Object

com.scriptbasic.syntax.AbstractNestedStructureHouseKeeper

All Implemented Interfaces:

FactoryManaged, NestedStructureHouseKeeper

Direct Known Subclasses:

GenericNestedStructureHouseKeeper

public abstract class AbstractNestedStructureHouseKeeper
extends Object
implements NestedStructureHouseKeeper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractNestedStructureHouseKeeper.Structure

Constructor Summary

Constructors

Constructor and Description
AbstractNestedStructureHouseKeeper()

Method Summary

Methods

Modifier and Type	Method and Description
Factory	getFactory()
protected boolean	isStackIsHealthy()
<T extends NestedStructure> T	pop(Class<T> expectedClass) Pops one element from the stack.
void	push(Class<?> klass, NestedStructure element) Push a nested structure object on the housekeeping stack.
void	push(NestedStructure element) Push a nested structure object on the housekeeping stack.
void	setFactory(Factory factory) When a factory creates an instance of a class implementing this interface this method is called to register the factory that created the instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNestedStructureHouseKeeper

public AbstractNestedStructureHouseKeeper()

Method Detail

getFactory

public Factory getFactory()

setFactory

public void setFactory(Factory factory)

Description copied from interface: FactoryManaged

When a factory creates an instance of a class implementing this interface this method is called to register the factory that created the instance.

Specified by:

setFactory in interface FactoryManaged

Parameters:

factory - the factory that manages the instance.

push

public void push(NestedStructure element)

Description copied from interface: NestedStructureHouseKeeper

Push a nested structure object on the housekeeping stack. This version of push does push the object associated with the actual class of the object.

Specified by:

push in interface NestedStructureHouseKeeper

Parameters:

element - to push on the stack.

isStackIsHealthy

protected boolean isStackIsHealthy()

push

public void push(Class<?> klass,
        NestedStructure element)

Description copied from interface: NestedStructureHouseKeeper

Push a nested structure object on the housekeeping stack.

Specified by:

push in interface NestedStructureHouseKeeper

Parameters:

klass - is the class that we will expect when we pop this element off

element - the element to be stored on the stack.

pop

public <T extends NestedStructure> T pop(Class<T> expectedClass)
                              throws AnalysisException

Description copied from interface: NestedStructureHouseKeeper

Pops one element from the stack.

Note that nested element have to be pushed on the stack nested. If we get an element off the stack that was not expected it means syntax error and therefore in this case exception is thrown.

When exception was thrown the functioning of the object is not defined by this interface. Some implementation may seek the appropriate element in the stack and throw off all top element until a proper type of element is found assuming that the user forgot to close some internal programming structured in the scripted language. Other implementations may follow more complex strategy to recover from such an error. In either case the sole reason of further syntax analysis is to discover as many syntax error as possible following the first one.

Specified by:

pop in interface NestedStructureHouseKeeper

Type Parameters:

T - expected type of the element

Returns:

the top element

Throws:

AnalysisException - when the top element of the stack is not the type that we expect