com.sap.netweaver.bc.rf.util.context
Interface IContextStack

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.util_api.jar]

All Known Implementing Classes:

ContextStack

public interface IContextStack

Interface describing a stack of context objects. This stack shall be used by context factories to store multiple stacked contexts within each thread. When no (more) context is available, a ContextUnavailableException is thrown.

Method Summary

java.lang.Object	getTypeUnsafeContext() Get actual context from stack of contexts.
java.lang.Object	getTypeUnsafeContextOrNullIfUnavailable() Get actual context from stack of contexts.
boolean	isAvailable() Checks if there is at least one actual context stacked.
java.lang.Object	popTypeUnsafeContext() Get and remove actual context from the stack of contexts.
void	pushTypeUnsafeContext(java.lang.Object context) Add new context to the top of the stack of contexts.
void	setTypeUnsafeContext(java.lang.Object context) Replace actual context with new one in stack of contexts.
int	size() Get the number of context entries in the stack of contexts.

Method Detail

isAvailable

public boolean isAvailable()

Checks if there is at least one actual context stacked.

Returns:

flag indicating whether there is at least one actual context stacked

size

public int size()

Get the number of context entries in the stack of contexts.

Returns:

number of context entries in the stack of contexts

getTypeUnsafeContext

public java.lang.Object getTypeUnsafeContext()
                                      throws ContextUnavailableException

Get actual context from stack of contexts.

Returns:

actual context on the context stack

Throws:

ContextUnavailableException - when no (more) context is available on the context stack

getTypeUnsafeContextOrNullIfUnavailable

public java.lang.Object getTypeUnsafeContextOrNullIfUnavailable()

Get actual context from stack of contexts. Return null if none is availble and don't throw a ContextUnavailableException.

Returns:

actual context on the context stack

setTypeUnsafeContext

public void setTypeUnsafeContext(java.lang.Object context)

Replace actual context with new one in stack of contexts. If no context is stored, this one will be added.

Parameters:

context - new actual context replacing the old one on the stack

popTypeUnsafeContext

public java.lang.Object popTypeUnsafeContext()
                                      throws ContextUnavailableException

Get and remove actual context from the stack of contexts.

Returns:

last actual context on the context stack

Throws:

ContextUnavailableException - when no (more) context is available on the context stack

pushTypeUnsafeContext

public void pushTypeUnsafeContext(java.lang.Object context)

Add new context to the top of the stack of contexts.

Parameters:

context - new actual context