|
|
|||||
| Package com.dassault_systemes.pprnblcabase.utils |
Class MessageStack
|
| Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.pprnblcabase.utils.MessageStack
| Class Location |
| Class Description |
public class MessageStack
Class to manage a stack of messages. An instance of this class will exists in the CATSession.
All Implemented Interfaces: Cloneable
| Field Summary |
| protected Stack | _stack
stack of message objects |
| Constructor Summary |
| MessageStack()
|
| Method Summary |
| public void | clearStack()
|
| public static Message[] | clearStack(CATSession iSession)
Clears the stack, returning the current messages on the stack. |
| protected Object | clone()
|
| public boolean | empty()
Tests if this stack is empty |
| public static boolean | empty(CATSession iSession)
|
| public int | getSize()
|
| public static int | getSize(CATSession iSession)
|
| public static MessageStack | getStack(CATSession iSession)
|
| public static MessageStack | getStack(CATSession iSession, boolean iCloneAndClear)
If iCloneAndClear is true, a copy of the session stack will be returned and the the session stack will be cleared (emptied). |
| public Message[] | peekStack()
|
| public static Message[] | peekStack(CATSession iSession)
Returns the stack of messages without removing them from the stack. |
| public Message | pop()
|
| public static Message | pop(CATSession iSession)
|
| public void | push(Message iMsg)
|
| public static void | push(Message iMsg, CATSession iSession)
Push a message onto the message stack, clearing the current msgs. |
| public static void | push(Message iMsg, CATSession iSession, boolean iClearStack)
Push a message onto the message stack |
| public static void | pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an error message |
| public static void | pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
|
| public static void | pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
|
| public static void | pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
|
| public static void | pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an info message |
| public static void | pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
|
| public static void | pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
|
| public static void | pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
|
| public static void | pushMessage(String iMsgFile, String iMsgKey, String[] iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
|
| public static void | pushMessage(String iMsgFile, String iMsgKey, Vector iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
|
| public static void | pushMessages(ENOVIClientCommand iCommand, CATSession iSession)
Push the message from the command onto message stack, clearing any previous messages. |
| public static void | pushMessages(ENOVIClientCommand iCommand, CATSession iSession, boolean iClearStack)
Push the message from the command onto message stack |
| public static void | pushMessages(ENOVICommand iCommand, CATSession iSession)
Push the message from the command onto message stack, clearing any previous messages. |
| public static void | pushMessages(ENOVICommand iCommand, CATSession iSession, boolean iClearStack)
Push the message from the command onto message stack |
| public static void | pushMessages(ENOVWebException iException, CATSession iSession)
Push the message from the exception onto message stack |
| public static void | pushMessages(ENOVWebException iException, CATSession iSession, boolean iClearStack)
Push the message from the exception onto message stack |
| public static void | pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an warning message |
| public static void | pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
|
| public static void | pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
|
| public static void | pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
|
| Field Detail |
protected Stack _stack
stack of message objects
| Constructor Detail |
MessageStack()
| Method Detail |
public void clearStack()
public static Message[] clearStack(CATSession iSession)
Clears the stack, returning the current messages on the stack.
protected Object clone()
public boolean empty()
Tests if this stack is empty
public static boolean empty(CATSession iSession)
public int getSize()
public static int getSize(CATSession iSession)
public static MessageStack getStack(CATSession iSession)
public static MessageStack getStack(CATSession iSession, boolean iCloneAndClear)
If iCloneAndClear is true, a copy of the session stack will be returned and the
the session stack will be cleared (emptied).
iSessioniCloneAndClear
public Message[] peekStack()
public static Message[] peekStack(CATSession iSession)
Returns the stack of messages without removing them from the stack.
public Message pop()
public static Message pop(CATSession iSession)
public void push(Message iMsg)
public static void push(Message iMsg, CATSession iSession)
Push a message onto the message stack, clearing the current msgs.
public static void push(Message iMsg, CATSession iSession, boolean iClearStack)
Push a message onto the message stack
public static void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an error message
public static void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
public static void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
public static void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
public static void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an info message
public static void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
public static void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
public static void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
public static void pushMessage(String iMsgFile, String iMsgKey, String[] iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
public static void pushMessage(String iMsgFile, String iMsgKey, Vector iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
public static void pushMessages(ENOVIClientCommand iCommand, CATSession iSession)
Push the message from the command onto message stack, clearing any previous messages.
public static void pushMessages(ENOVIClientCommand iCommand, CATSession iSession, boolean iClearStack)
Push the message from the command onto message stack
public static void pushMessages(ENOVICommand iCommand, CATSession iSession)
Push the message from the command onto message stack, clearing any previous messages.
public static void pushMessages(ENOVICommand iCommand, CATSession iSession, boolean iClearStack)
Push the message from the command onto message stack
public static void pushMessages(ENOVWebException iException, CATSession iSession)
Push the message from the exception onto message stack
public static void pushMessages(ENOVWebException iException, CATSession iSession, boolean iClearStack)
Push the message from the exception onto message stack
public static void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an warning message
public static void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
public static void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
public static void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)