org.eclipse.ocl.pivot.internal.helper

Class HelperUtil

java.lang.Object

org.eclipse.ocl.pivot.internal.helper.HelperUtil

public class HelperUtil
extends java.lang.Object

Utility class in support of the implementation of the OCLHelper API, also responsible for the creation of OCLHelpers.

Author:

Yasser Lulu, Christian W. Damus (cdamus)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_STRING

Method Summary

Modifier and Type	Method and Description
static void	catching(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Throwable throwable) Traces the catching of the specified throwable in the specified method of the specified class.
static void	error(int code, java.lang.String message) Generates an error log for the specified plug-in, with the specified status code, message.
static void	error(int code, java.lang.String message, java.lang.Throwable throwable) Generates an error log for the specified plug-in, with the specified status code, message, and throwable.
static void	info(int code, java.lang.String message) Generates an information log for the specified plug-in, with the specified status code, message.
static void	info(int code, java.lang.String message, java.lang.Throwable throwable) Generates an information log for the specified plug-in, with the specified status code, message, and throwable.
static void	info(java.lang.String message) Generates an information log for the specified plug-in, with the specified message.
static void	log(int severity, int code, java.lang.String message, java.lang.Throwable throwable)
static boolean	shouldTrace(java.lang.String option)
static void	throwing(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Throwable throwable)
static void	trace(java.lang.String message) Emits the specified message to the trace log.
static void	warning(int code, java.lang.String message) Generates a warning log for the specified plug-in, with the specified status code, message.
static void	warning(int code, java.lang.String message, java.lang.Throwable throwable) Generates a warning log for the specified plug-in, with the specified status code, message, and throwable.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING

@NonNull
public static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

Method Detail

catching

public static void catching(java.lang.Class<?> clazz,
                            java.lang.String methodName,
                            java.lang.Throwable throwable)

Traces the catching of the specified throwable in the specified method of the specified class.

Parameters:

clazz - The class in which the throwable is being caught.

methodName - The name of the method in which the throwable is being caught.

throwable - The throwable that is being caught.

throwing

public static void throwing(java.lang.Class<?> clazz,
                            java.lang.String methodName,
                            java.lang.Throwable throwable)

shouldTrace

public static boolean shouldTrace(java.lang.String option)

trace

public static void trace(java.lang.String message)

Emits the specified message to the trace log. It is the caller's responsibility to ensure that the appropriate tracing option is enabled.

Parameters:

message - a message

See Also:

shouldTrace(String)

error

public static void error(int code,
                         java.lang.String message)

Generates an error log for the specified plug-in, with the specified status code, message.

Parameters:

code - The status code for the log.

message - The message for the log.

error

public static void error(int code,
                         java.lang.String message,
                         java.lang.Throwable throwable)

Generates an error log for the specified plug-in, with the specified status code, message, and throwable.

Parameters:

code - The status code for the log.

message - The message for the log.

throwable - The throwable for the log.

info

public static void info(java.lang.String message)

Generates an information log for the specified plug-in, with the specified message. Uses OK as status code.

Parameters:

message - The message for the log.

info

public static void info(int code,
                        java.lang.String message)

Generates an information log for the specified plug-in, with the specified status code, message.

Parameters:

code - The status code for the log.

message - The message for the log.

info

public static void info(int code,
                        java.lang.String message,
                        java.lang.Throwable throwable)

Generates an information log for the specified plug-in, with the specified status code, message, and throwable.

Parameters:

code - The status code for the log.

message - The message for the log.

throwable - The throwable for the log.

warning

public static void warning(int code,
                           java.lang.String message)

Generates a warning log for the specified plug-in, with the specified status code, message.

Parameters:

code - The status code for the log.

message - The message for the log.

warning

public static void warning(int code,
                           java.lang.String message,
                           java.lang.Throwable throwable)

Generates a warning log for the specified plug-in, with the specified status code, message, and throwable.

Parameters:

code - The status code for the log.

message - The message for the log.

throwable - The throwable for the log.

log

public static void log(int severity,
                       int code,
                       java.lang.String message,
                       java.lang.Throwable throwable)