Copyright (c) 2000, 2011 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2000, 2011 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.core.variables;

import org.eclipse.core.internal.variables.StringVariableManager;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Plugin;
import org.eclipse.core.runtime.Status;

The plug-in runtime class for the Core Variables plug-in.
Since:
3.0
@noinstantiate
This class is not intended to be instantiated by clients.
@noextend
This class is not intended to be subclassed by clients./**
 * The plug-in runtime class for the Core Variables plug-in.
 * @since 3.0
 * @noinstantiate This class is not intended to be instantiated by clients.
 * @noextend This class is not intended to be subclassed by clients.
 */
public class VariablesPlugin extends Plugin {

	
Status code indicating an unexpected internal error.
/**
	 * Status code indicating an unexpected internal error.
	 */
	public static final int INTERNAL_ERROR = 120;

	
Status code indicating a variable reference cycle error.
/**
	 * Status code indicating a variable reference cycle error.
	 */
	public static final int REFERENCE_CYCLE_ERROR = 130;

	
The single instance of this plug-in runtime class.
/**
	 * The single instance of this plug-in runtime class.
	 */
	private static VariablesPlugin plugin;

	
Unique identifier constant (value "org.eclipse.core.variables")
for the Core Variables plug-in.
/**
	 * Unique identifier constant (value <code>"org.eclipse.core.variables"</code>)
	 * for the Core Variables plug-in.
	 */
	public static final String PI_CORE_VARIABLES = "org.eclipse.core.variables"; //$NON-NLS-1$


	
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.

/**
	 * Constructs an instance of this plug-in runtime class.
	 * <p>
	 * An instance of this plug-in runtime class is automatically created
	 * when the facilities provided by the Variables plug-in are required.
	 * <b>Clients must never explicitly instantiate a plug-in runtime class.</b>
	 * </p>
	 */
	public VariablesPlugin() {
		super();
		plugin = this;
	}

	
Returns this plug-in instance.
Returns:
the single instance of this plug-in runtime class/**
	 * Returns this plug-in instance.
	 *
	 * @return the single instance of this plug-in runtime class
	 */
	public static VariablesPlugin getDefault() {
		return plugin;
	}

	
Logs the specified throwable with this plug-in's log.
Params:
t – throwable to log/**
	 * Logs the specified throwable with this plug-in's log.
	 *
	 * @param t throwable to log
	 */
	public static void log(Throwable t) {
		log(new Status(IStatus.ERROR, PI_CORE_VARIABLES, INTERNAL_ERROR, "Error logged from Core Variables: ", t)); //$NON-NLS-1$
	}

	
Logs the given message with this plug-in's log and the given
throwable or null if none.
Params:
message – the message to log
throwable – the exception that occurred or null if none/**
	 * Logs the given message with this plug-in's log and the given
	 * throwable or <code>null</code> if none.
	 * @param message the message to log
	 * @param throwable the exception that occurred or <code>null</code> if none
	 */
	public static void logMessage(String message, Throwable throwable) {
		log(new Status(IStatus.ERROR, getUniqueIdentifier(), INTERNAL_ERROR, message, throwable));
	}

	
Logs the specified status with this plug-in's log.
Params:
status – status to log/**
	 * Logs the specified status with this plug-in's log.
	 *
	 * @param status status to log
	 */
	public static void log(IStatus status) {
		getDefault().getLog().log(status);
	}

	
Convenience method which returns the unique identifier of this plug-in.
Returns:
the identifier of this plug-in/**
	 * Convenience method which returns the unique identifier of this plug-in.
	 * @return the identifier of this plug-in
	 */
	public static String getUniqueIdentifier() {
		return PI_CORE_VARIABLES;
	}

	
Returns the string variable manager.
Returns:
the string variable manager/**
	 * Returns the string variable manager.
	 *
	 * @return the string variable manager
	 */
	public IStringVariableManager getStringVariableManager() {
		return StringVariableManager.getDefault();
	}
}