com.ebmwebsourcing.petals.services.filetransfer.FileTransferPlugin.java Source code

Introduction

Here is the source code for com.ebmwebsourcing.petals.services.filetransfer.FileTransferPlugin.java

Source

/******************************************************************************
 * Copyright (c) 2009-2013, Linagora
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *       Linagora - initial API and implementation
 *******************************************************************************/

package com.ebmwebsourcing.petals.services.filetransfer;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;

/**
 * The activator class controls the plug-in life cycle
 * @author Vincent Zurczak - EBM WebSourcing
 */
public class FileTransferPlugin extends AbstractUIPlugin {

    // The plug-in ID
    public static final String PLUGIN_ID = "com.ebmwebsourcing.petals.services.filetransfer";

    // The shared instance
    private static FileTransferPlugin plugin;

    /**
     * The constructor
     */
    public FileTransferPlugin() {
        // nothing
    }

    /*
     * (non-Javadoc)
     * @see org.eclipse.ui.plugin.AbstractUIPlugin
     * #start(org.osgi.framework.BundleContext)
     */
    @Override
    public void start(BundleContext context) throws Exception {
        super.start(context);
        plugin = this;
    }

    /*
     * (non-Javadoc)
     * @see org.eclipse.ui.plugin.AbstractUIPlugin
     * #stop(org.osgi.framework.BundleContext)
     */
    @Override
    public void stop(BundleContext context) throws Exception {
        plugin = null;
        super.stop(context);
    }

    /**
     * Returns the shared instance
     * @return the shared instance
     */
    public static FileTransferPlugin getDefault() {
        return plugin;
    }

    /**
     * Returns an image descriptor for the image file at the given
     * plug-in relative path
     *
     * @param path the path
     * @return the image descriptor
     */
    public static ImageDescriptor getImageDescriptor(String path) {
        return imageDescriptorFromPlugin(PLUGIN_ID, path);
    }

    /**
     * Logs an exception.
     * @param e the exception to log
     * @param severity the severity, given as one of the {@link IStatus} constants
     */
    public static void log(Exception e, int severity) {

        String msg = e.getMessage();
        if (msg == null || msg.trim().length() == 0)
            msg = "An error occurred.";

        IStatus status = new Status(severity, PLUGIN_ID, msg, e);
        getDefault().getLog().log(status);
    }

    /**
     * Logs a message.
     * @param message the message to log
     * @param severity the severity, given as one of the {@link IStatus} constants
     */
    public static void log(String message, int severity) {
        IStatus status = new Status(severity, PLUGIN_ID, message);
        getDefault().getLog().log(status);
    }

    /**
     * Logs a message and an exception.
     * @param e the exception to log
     * @param severity the severity, given as one of the {@link IStatus} constants
     * @param message the message to log
     */
    public static void log(Exception e, int severity, String message) {
        IStatus status = new Status(severity, PLUGIN_ID, message, e);
        getDefault().getLog().log(status);
    }

    /**
     * Loads the image located by this path in the current plug-in.
     * <p>
     * If the path is invalid or if the image could not be loaded, a log entry is created.
     * </p>
     *
     * @param path the relative image path in the plug-in
     * @return the image or null if it could not be loaded
     */
    public static Image loadImage(String path) {

        Image img = null;
        try {
            ImageDescriptor desc = getImageDescriptor(path);
            if (desc != null)
                img = desc.createImage();

        } catch (Exception e) {
            log(e, IStatus.WARNING);
        }

        return img;
    }
}