org.eclipse.ocl.internal

Class OCLPlugin

java.lang.Object

EMFPlugin

org.eclipse.ocl.internal.OCLPlugin

public class OCLPlugin
extends EMFPlugin

The activator class controls the plug-in life cycle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OCLPlugin.Implementation The definition of the Eclipse plug-in flavour of this EMF plug-in.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_STRING
static OCLPlugin	INSTANCE

Constructor Summary

Constructors

Constructor and Description
OCLPlugin() The constructor.

Method Summary

Modifier and Type	Method and Description
static void	catching(Class<?> clazz, String methodName, Throwable throwable) Traces the catching of the specified throwable in the specified method of the specified class.
static void	error(int code, String message) Generates an error log for the specified plug-in, with the specified status code, message.
static void	error(int code, String message, Throwable throwable) Generates an error log for the specified plug-in, with the specified status code, message, and throwable.
static OCLPlugin	getInstance() Returns the shared instance.
static OCLPlugin.Implementation	getPlugin() Obtains the Eclipse plug-in that I implement.
static String	getPluginId()
ResourceLocator	getPluginResourceLocator()
static void	info(int code, String message) Generates an information log for the specified plug-in, with the specified status code, message.
static void	info(int code, String message, Throwable throwable) Generates an information log for the specified plug-in, with the specified status code, message, and throwable.
static void	info(String message) Generates an information log for the specified plug-in, with the specified message.
static void	log(int severity, int code, String message, Throwable throwable)
static boolean	shouldTrace(String option)
static void	throwing(Class<?> clazz, String methodName, Throwable throwable)
static void	trace(String message) Emits the specified message to the trace log.
static void	warning(int code, String message) Generates a warning log for the specified plug-in, with the specified status code, message.
static void	warning(int code, String message, 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

public static final String EMPTY_STRING

See Also:

Constant Field Values

INSTANCE

public static OCLPlugin INSTANCE

Constructor Detail

OCLPlugin

public OCLPlugin()

The constructor.

Method Detail

getPluginId

public static String getPluginId()

getPluginResourceLocator

public ResourceLocator getPluginResourceLocator()

getPlugin

public static OCLPlugin.Implementation getPlugin()

Obtains the Eclipse plug-in that I implement.

Returns:

my Eclipse plug-in self

getInstance

public static OCLPlugin getInstance()

Returns the shared instance.

catching

public static void catching(Class<?> clazz,
                            String methodName,
                            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(Class<?> clazz,
                            String methodName,
                            Throwable throwable)

shouldTrace

public static boolean shouldTrace(String option)

trace

public static void trace(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,
                         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,
                         String message,
                         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(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,
                        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,
                        String message,
                        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,
                           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,
                           String message,
                           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,
                       String message,
                       Throwable throwable)