org.safs.tools.stacks

Class SAFSSTACKS

java.lang.Object

org.safs.tools.stacks.SAFSSTACKS

All Implemented Interfaces:

GenericToolsInterface, SimpleToolsInterface, StacksInterface

public class SAFSSTACKS
extends java.lang.Object
implements SimpleToolsInterface, StacksInterface

Constructor Summary

Constructors

Constructor and Description
SAFSSTACKS() Constructor for SAFSSTACKS

Method Summary

Modifier and Type	Method and Description
long	count()
CoreInterface	getCoreInterface() Retrieve the instance of the CoreInterface used to communicate with the framework.
boolean	isEmpty()
boolean	isToolRunning() TRUE if the underlying tool is running.
void	launchInterface() Launch/initialize the underlying tool or service.
StatusInfoInterface	peekStack()
StatusInfoInterface	popStack()
long	pushStack(StatusInfoInterface statusInfo)
void	reset() Reset or clear any cached information in the underlying tool or service.
void	shutdown() Shutdown the underlying tool or service.

Methods inherited from class java.lang.Object

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

Constructor Detail

SAFSSTACKS

public SAFSSTACKS()

Constructor for SAFSSTACKS

Method Detail

launchInterface

public void launchInterface()

Description copied from interface: SimpleToolsInterface

Launch/initialize the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is already running, or not. If the tool is already running, then it should exit gracefully without adversely affecting anything.

Specified by:

launchInterface in interface SimpleToolsInterface

See Also:

SimpleToolsInterface.launchInterface()

pushStack

public long pushStack(StatusInfoInterface statusInfo)

Specified by:

pushStack in interface StacksInterface

See Also:

StacksInterface.pushStack(StatusInfoInterface)

peekStack

public StatusInfoInterface peekStack()

Specified by:

peekStack in interface StacksInterface

See Also:

StacksInterface.peekStack()

popStack

public StatusInfoInterface popStack()

Specified by:

popStack in interface StacksInterface

See Also:

StacksInterface.popStack()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface StacksInterface

See Also:

StacksInterface.isEmpty()

count

public long count()

Specified by:

count in interface StacksInterface

See Also:

StacksInterface.count()

getCoreInterface

public CoreInterface getCoreInterface()
                               throws java.lang.IllegalStateException

Description copied from interface: GenericToolsInterface

Retrieve the instance of the CoreInterface used to communicate with the framework.

Specified by:

getCoreInterface in interface GenericToolsInterface

Returns:

CoreInterface instance.

Throws:

java.lang.IllegalStateException - ALWAYS since there is no CoreInterface in this class.

See Also:

GenericToolsInterface#getCoreInterface()

isToolRunning

public boolean isToolRunning()

TRUE if the underlying tool is running. Typically called AFTER initialization attempts have been made.

Specified by:

isToolRunning in interface GenericToolsInterface

reset

public void reset()

Description copied from interface: GenericToolsInterface

Reset or clear any cached information in the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

reset in interface GenericToolsInterface

See Also:

GenericToolsInterface#reset()

shutdown

public void shutdown()

Description copied from interface: GenericToolsInterface

Shutdown the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

shutdown in interface GenericToolsInterface

See Also:

GenericToolsInterface#shutdown()