|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.systems.core.messages.SystemMessage
Error message window class.
Field Summary | |
---|---|
static char |
COMPLETION
Completion message indicator (added by DWD) |
static String |
copyright
|
static char |
ERROR
Error message indicator |
static char |
INFORMATION
Information message indicator |
static char |
INQUIRY
Inquiry message indicator |
protected static String |
NESTING_INDENT
|
static char |
UNEXPECTED
Unexpected message indicator (same as warning but will log exception & stack in message log) |
static char |
WARNING
Warning message indicator |
Constructor Summary | |
---|---|
SystemMessage(String comp,
String sub,
String number,
char ind,
String l1,
String l2)
SystemMesssage constructor Throws: IndicatorException: the indicator specified is not a valid indicator |
Method Summary | |
---|---|
String |
getComponent()
|
String |
getFullMessageID()
Use this method to retrieve the full message ID: Component + SubComponent + Number + indicator |
char |
getIndicator()
Use this method to get the severity. |
String |
getLevelOneText()
Use this method to retrieve level one text |
String |
getLevelTwoText()
Use this method to retrieve level two text |
String |
getLongMessageID()
Use this method to retrieve 'long' message ID format: Component + SubComponent + Number. |
String |
getMessageID()
Use this method to retrieve 'standard' message ID format: Component + Number |
String |
getMessageNumber()
|
int |
getNumSubstitutionVariables()
Use this method to retrieve the unique number of substitution variables in this message (this would include level 1 and 2 text |
String |
getSubComponent()
|
String |
getSubValue(Object sub)
used to determine the string value of the object it calls toString for all object types except for Exceptions where the stack is also rendered |
Object[] |
getSubVariables()
retrieves an array of substitution variables |
boolean |
hasLongID(String messageId)
Tests if this message has a long id equal to the one supplied in the argument. |
SystemMessage |
makeSubstitution(Object sub1)
Use this method to set substitution value %1. |
SystemMessage |
makeSubstitution(Object[] subsList)
Use this method to set substitution values Generally toString() is used on the substitution objects, but there is special case handling for exception objects and IStatus objects. |
SystemMessage |
makeSubstitution(Object sub1,
Object sub2)
Use this method to set substitution value %1 %2 Generally toString() is used on the substitution objects, but there is special case handling for exception objects and IStatus objects. |
SystemMessage |
makeSubstitution(Object sub1,
Object sub2,
Object sub3)
Use this method to set substitution value %1 %2 %3 Generally toString() is used on the substitution objects, but there is special case handling for exception objects and IStatus objects. |
SystemMessage |
makeSubstitution(Object sub1,
Object sub2,
Object sub3,
Object sub4)
Use this method to set substitution value %1 %2 %3 %4 Generally toString() is used on the substitution objects, but there is special case handling for exception objects and IStatus objects. |
void |
setIndicator(char ind)
Use this method to override the default severity of a message Throws SeverityException if the severity is not valid |
void |
setPrefixChar(char prefixChar)
|
static String |
sub(String msg,
String subOld,
String subNew)
Do message variable substitution. |
String |
toString()
Convert this message to a string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String copyright
public static final char COMPLETION
public static final char INQUIRY
public static final char INFORMATION
public static final char ERROR
public static final char WARNING
public static final char UNEXPECTED
protected static final String NESTING_INDENT
Constructor Detail |
public SystemMessage(String comp, String sub, String number, char ind, String l1, String l2) throws IndicatorException
Throws:
Method Detail |
public void setIndicator(char ind) throws IndicatorException
IndicatorException
public char getIndicator()
INQUIRY
for a question message.
COMPLETION
for a completion message.
INFORMATION
for an informational message.
ERROR
for an error message.
WARNING
for a warning message.
UNEXPECTED
for an unexpected-situation-encountered message.
public String getMessageNumber()
public String getComponent()
public String getSubComponent()
public int getNumSubstitutionVariables()
public String getLevelOneText()
public String getLevelTwoText()
public String getFullMessageID()
public String getLongMessageID()
public String getMessageID()
public boolean hasLongID(String messageId)
messageId
- the long message id to compare against.
public SystemMessage makeSubstitution(Object sub1)
public SystemMessage makeSubstitution(Object sub1, Object sub2)
public SystemMessage makeSubstitution(Object sub1, Object sub2, Object sub3)
public SystemMessage makeSubstitution(Object sub1, Object sub2, Object sub3, Object sub4)
public SystemMessage makeSubstitution(Object[] subsList)
public Object[] getSubVariables()
public void setPrefixChar(char prefixChar)
public static String sub(String msg, String subOld, String subNew)
subOld
- - substitution variable. Eg "%1"subNew
- - substitution data. Eg "001"
public String toString()
public String getSubValue(Object sub)
sub
- the substitution object
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |