com.atlassian.connector.eclipse.team.ui.TeamUiMessageUtils.java Source code

Introduction

Here is the source code for com.atlassian.connector.eclipse.team.ui.TeamUiMessageUtils.java

Source

/*******************************************************************************
 * Copyright (c) 2009 Atlassian and others.
 * 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:
 *     Atlassian - initial API and implementation
 ******************************************************************************/

package com.atlassian.connector.eclipse.team.ui;

import com.atlassian.connector.eclipse.team.ui.exceptions.UnsupportedTeamProviderException;

import org.apache.commons.lang.StringUtils;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.PlatformUI;

/**
 * Class to handle displaying team error messages to users
 * 
 * @author Shawn Minto
 */
public final class TeamUiMessageUtils {

    private TeamUiMessageUtils() {
    }

    private static final String MESSAGE_DIALOG_TITLE = "Crucible";

    public static void openFileDeletedErrorMessage(final String repoUrl, final String filePath,
            final String revision) {
        if (Display.getCurrent() != null) {
            internalOpenFileDeletedErrorMessage(repoUrl, filePath, revision);
        } else {
            PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
                public void run() {
                    internalOpenFileDeletedErrorMessage(repoUrl, filePath, revision);
                }
            });
        }

    }

    private static String getErrorHints() {
        return "- You have correctly defined Repository Mappings.\n"
                + "- You are using a supported team provider. Supported providers: "
                + StringUtils.join(TeamUiUtils.getSupportedTeamConnectors(), ", ");
    }

    private static void internalOpenFileDeletedErrorMessage(String repoUrl, String filePath, String revision) {
        String message = "Unable to open file.  Please check that:\n\n" + getErrorHints();
        MessageDialog.openInformation(null, MESSAGE_DIALOG_TITLE, message);
    }

    public static void openFileDoesntExistErrorMessage(final String repoUrl, final String filePath,
            final String revision) {
        if (Display.getCurrent() != null) {
            internalOpenFileDoesntExistErrorMessage(repoUrl, filePath, revision);
        } else {
            PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
                public void run() {
                    internalOpenFileDoesntExistErrorMessage(repoUrl, filePath, revision);
                }
            });
        }
    }

    public static void openCouldNotOpenFileErrorMessage(final String repoUrl, final String filePath,
            final String revision) {
        if (Display.getCurrent() != null) {
            internalOpenFileDoesntExistErrorMessage(repoUrl, filePath, revision);
        } else {
            PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
                public void run() {
                    internalOpenFileDoesntExistErrorMessage(repoUrl, filePath, revision);
                }
            });
        }
    }

    private static void internalOpenFileDoesntExistErrorMessage(String repoUrl, String filePath, String revision) {
        internalOpenFileDeletedErrorMessage(repoUrl, filePath, revision);
    }

    public static void openUnableToCompareErrorMessage(final String repoUrl, final String filePath,
            final String oldRevision, final String newRevision, final Throwable e) {
        if (Display.getCurrent() != null) {
            internalOpenUnableToCompareErrorMessage(repoUrl, filePath, oldRevision, newRevision, e);
        } else {
            PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
                public void run() {
                    internalOpenUnableToCompareErrorMessage(repoUrl, filePath, oldRevision, newRevision, e);
                }
            });
        }
    }

    public static void openUnsupportedTeamProviderErrorMessage(final UnsupportedTeamProviderException exception) {
        if (Display.getCurrent() != null) {
            internalOpenUnsupportedTeamProviderErrorMessage(exception);
        } else {
            PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
                public void run() {
                    internalOpenUnsupportedTeamProviderErrorMessage(exception);
                }
            });
        }
    }

    private static void internalOpenUnsupportedTeamProviderErrorMessage(
            final UnsupportedTeamProviderException exception) {
        String message = NLS.bind("Unsupported team provider ({0}).\n\n" + "Supported team providers are:\n"
                + StringUtils.join(TeamUiUtils.getSupportedTeamConnectors(), ", ") + "\nSee the "
                + " web site for future updates.", exception.getMessage());

        MessageDialog.openWarning(null, MESSAGE_DIALOG_TITLE, message);
    }

    private static void internalOpenUnableToCompareErrorMessage(String repoUrl, String filePath, String oldRevision,
            String newRevision, Throwable e) {
        String message = "Unable to compare revisions. ";

        if (e != null) {
            message += "Following exception was catched:\n\n";
            message += e.getMessage();
            message += "\n\n";
        }

        message += "Please check that:\n\n" + getErrorHints();
        message += "\n\nPlease check also Error Log for details.";
        MessageDialog.openInformation(null, MESSAGE_DIALOG_TITLE, message);
    }
}