com.ptc.windchill.cadx.common.htmllog
Class HTMLLogHelper

java.lang.Object
  com.ptc.windchill.cadx.common.htmllog.HTMLLogHelper

All Implemented Interfaces:

Externalizable, Serializable

public class HTMLLogHelper

extends Object

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	PREF_DS
private static String	RESOURCE
(package private) static long	serialVersionUID
static HTMLLogService	service Supported API: false
static String	SHOW_CONSOLE_KEY

Constructor Summary

HTMLLogHelper()

Method Summary

static String	addDebugMessage(String message) Supported API: false
static String	addDebugMessage(String message, Exception exception, Locale locale) Supported API: false
static String	addDebugMessage(String rb, String rbKey, Object[] params, Exception exception, Locale locale) Supported API: false
static String	addErrorMessage(String message) Supported API: false
static String	addErrorMessage(String message, Exception exception, Locale locale) Supported API: false
static String	addErrorMessage(String rb, String rbKey, Object[] params, Exception exception, Locale locale) Supported API: false
static String	addInfoMessage(String message) Supported API: false
static String	addInfoMessage(String message, Exception exception, Locale locale) Supported API: false
static String	addInfoMessage(String rb, String rbKey, Object[] params, Exception exception, Locale locale) Supported API: false
private static String	addMessage(int messageType, String message)
private static String	addMessage(int messageType, String message, Exception exception, Locale locale)
private static String	addMessage(int messageType, String rb, String rbKey, Object[] params, Exception exception, Locale locale)
static String	addStatusMessage(String message) Supported API: false
static String	addStatusMessage(String message, Exception exception, Locale locale) Supported API: false
static String	addStatusMessage(String rb, String rbKey, Object[] params, Exception exception, Locale locale) Supported API: false
static String	addWarningMessage(String message) Supported API: false
static String	addWarningMessage(String message, Exception exception, Locale locale) Supported API: false
static String	addWarningMessage(String rb, String rbKey, Object[] params, Exception exception, Locale locale) Supported API: false
static String	getPrefSectionString(int messageType) Returns the pref.
static String	getPrefValue(int messageType, String key) Returns the pref.
static String	getPrefValue(int messageType, String key, String defaultValue) Returns the pref.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(HTMLLogHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static boolean	shouldDisplayMessage(int messageType, String key)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

service

public static final HTMLLogService service

Supported API: false

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

SHOW_CONSOLE_KEY

public static final String SHOW_CONSOLE_KEY

See Also:

Constant Field Values

PREF_DS

public static final String PREF_DS

See Also:

Constant Field Values

Constructor Detail

HTMLLogHelper

public HTMLLogHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(HTMLLogHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

addDebugMessage

public static String addDebugMessage(String message,
                                     Exception exception,
                                     Locale locale)
                              throws WTException

Supported API: false

Parameters:

message -

exception -

locale -

Returns:

String

Throws:

WTException

addDebugMessage

public static String addDebugMessage(String rb,
                                     String rbKey,
                                     Object[] params,
                                     Exception exception,
                                     Locale locale)
                              throws WTException

Supported API: false

Parameters:

rb -

rbKey -

params -

exception -

locale -

Returns:

String

Throws:

WTException

addMessage

private static String addMessage(int messageType,
                                 String message,
                                 Exception exception,
                                 Locale locale)
                          throws WTException

Parameters:

messageType -

message -

exception -

locale -

Returns:

String

Throws:

WTException

addMessage

private static String addMessage(int messageType,
                                 String rb,
                                 String rbKey,
                                 Object[] params,
                                 Exception exception,
                                 Locale locale)
                          throws WTException

Parameters:

messageType -

rb -

rbKey -

params -

exception -

locale -

Returns:

String

Throws:

WTException

addStatusMessage

public static String addStatusMessage(String message,
                                      Exception exception,
                                      Locale locale)
                               throws WTException

Supported API: false

Parameters:

message -

exception -

locale -

Returns:

String

Throws:

WTException

addInfoMessage

public static String addInfoMessage(String message,
                                    Exception exception,
                                    Locale locale)
                             throws WTException

Supported API: false

Parameters:

message -

exception -

locale -

Returns:

String

Throws:

WTException

addWarningMessage

public static String addWarningMessage(String message,
                                       Exception exception,
                                       Locale locale)
                                throws WTException

Supported API: false

Parameters:

message -

exception -

locale -

Returns:

String

Throws:

WTException

addErrorMessage

public static String addErrorMessage(String message,
                                     Exception exception,
                                     Locale locale)
                              throws WTException

Supported API: false

Parameters:

message -

exception -

locale -

Returns:

String

Throws:

WTException

addStatusMessage

public static String addStatusMessage(String rb,
                                      String rbKey,
                                      Object[] params,
                                      Exception exception,
                                      Locale locale)
                               throws WTException

Supported API: false

Parameters:

rb -

rbKey -

params -

exception -

locale -

Returns:

String

Throws:

WTException

addInfoMessage

public static String addInfoMessage(String rb,
                                    String rbKey,
                                    Object[] params,
                                    Exception exception,
                                    Locale locale)
                             throws WTException

Supported API: false

Parameters:

rb -

rbKey -

params -

exception -

locale -

Returns:

String

Throws:

WTException

addWarningMessage

public static String addWarningMessage(String rb,
                                       String rbKey,
                                       Object[] params,
                                       Exception exception,
                                       Locale locale)
                                throws WTException

Supported API: false

Parameters:

rb -

rbKey -

params -

exception -

locale -

Returns:

String

Throws:

WTException

addErrorMessage

public static String addErrorMessage(String rb,
                                     String rbKey,
                                     Object[] params,
                                     Exception exception,
                                     Locale locale)
                              throws WTException

Supported API: false

Parameters:

rb -

rbKey -

params -

exception -

locale -

Returns:

String

Throws:

WTException

addDebugMessage

public static String addDebugMessage(String message)
                              throws WTException

Supported API: false

Parameters:

message -

Returns:

String

Throws:

WTException

addStatusMessage

public static String addStatusMessage(String message)
                               throws WTException

Supported API: false

Parameters:

message -

Returns:

String

Throws:

WTException

addInfoMessage

public static String addInfoMessage(String message)
                             throws WTException

Supported API: false

Parameters:

message -

Returns:

String

Throws:

WTException

addWarningMessage

public static String addWarningMessage(String message)
                                throws WTException

Supported API: false

Parameters:

message -

Returns:

String

Throws:

WTException

addErrorMessage

public static String addErrorMessage(String message)
                              throws WTException

Supported API: false

Parameters:

message -

Returns:

String

Throws:

WTException

addMessage

private static String addMessage(int messageType,
                                 String message)
                          throws WTException

Parameters:

messageType -

message -

Returns:

String

Throws:

WTException

shouldDisplayMessage

public static boolean shouldDisplayMessage(int messageType,
                                           String key)

getPrefSectionString

public static String getPrefSectionString(int messageType)

Returns the pref. section string corresponding to the messageType. If messageType is passed as -1 it return "general".

getPrefValue

public static String getPrefValue(int messageType,
                                  String key)

Returns the pref. value for the passed messageType and key from console.ini. If key does not exist in console.ini then returns "no".

getPrefValue

public static String getPrefValue(int messageType,
                                  String key,
                                  String defaultValue)

Returns the pref. value for the passed messageType and key from console.ini. If key does not exist in console.ini then returns passed defaultValue.