Eclipse Plug-in Developer Guide (Galileo) - VariablesPlugin (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.variables
Class VariablesPlugin


java.lang.Object
  

org.eclipse.core.runtime.Plugin
      
org.eclipse.core.variables.VariablesPlugin

All Implemented Interfaces:: BundleActivator

public class VariablesPlugin
extends Plugin
extends Plugin

The plug-in runtime class for the Core Variables plug-in.

Since:: 3.0
Restriction:: This class is not intended to be subclassed by clients.
Restriction:: This class is not intended to be instantiated by clients.

Field Summary

static int INTERNAL_ERROR
          Status code indicating an unexpected internal error.

static String PI_CORE_VARIABLES
          Unique identifier constant (value "org.eclipse.core.variables") for the Core Variables plug-in.

static int REFERENCE_CYCLE_ERROR
          Status code indicating a variable reference cycle error.

Fields inherited from class org.eclipse.core.runtime. Plugin

PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

VariablesPlugin ()
          Constructs an instance of this plug-in runtime class.

Method Summary

static VariablesPlugin getDefault ()
          Returns this plug-in instance.

IStringVariableManager getStringVariableManager ()
          Returns the string variable manager.

static String getUniqueIdentifier ()
          Convenience method which returns the unique identifier of this plug-in.

static void log ( IStatus status)
          Logs the specified status with this plug-in's log.

static void log ( Throwable t)
          Logs the specified throwable with this plug-in's log.

static void logMessage ( String message, Throwable throwable)
          Logs the given message with this plug-in's log and the given throwable or null if none.

Methods inherited from class org.eclipse.core.runtime. Plugin

find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, shutdown, start, startup, stop, toString

Methods inherited from class java.lang. Object

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

Field Detail

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Status code indicating an unexpected internal error.

See Also:: Constant Field Values

REFERENCE_CYCLE_ERROR

public static final int REFERENCE_CYCLE_ERROR

Status code indicating a variable reference cycle error.

See Also:: Constant Field Values

PI_CORE_VARIABLES

public static final 
String PI_CORE_VARIABLES

Unique identifier constant (value "org.eclipse.core.variables") for the Core Variables plug-in.

See Also:: Constant Field Values

Constructor Detail

VariablesPlugin

public VariablesPlugin()

Constructs an instance of this plug-in runtime class.

An instance of this plug-in runtime class is automatically created when the facilities provided by the Variables plug-in are required. Clients must never explicitly instantiate a plug-in runtime class.

Method Detail

getDefault

public static 
VariablesPlugin getDefault()

Returns this plug-in instance.

Returns:: the single instance of this plug-in runtime class

log

public static void log(
Throwable t)

Logs the specified throwable with this plug-in's log.

Parameters:: t - throwable to log

logMessage

public static void logMessage(
String message,
                              
Throwable throwable)

Logs the given message with this plug-in's log and the given throwable or null if none.

Parameters:: message - the message to log; throwable - the exception that occurred or null if none

log

public static void log(
IStatus status)

Logs the specified status with this plug-in's log.

Parameters:: status - status to log

getUniqueIdentifier

public static 
String getUniqueIdentifier()

Convenience method which returns the unique identifier of this plug-in.

getStringVariableManager

public 
IStringVariableManager getStringVariableManager()

Returns the string variable manager.

Returns:: the string variable manager