PluginUtils.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo Framework
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.plugin.api;

import com.qcadoo.plugin.internal.PluginUtilsService;

/**
 * Utils to checking plugin's state.
 * 
 * @since 0.4.0
 */
public final class PluginUtils {

    private PluginUtils() {
    }

    /**
     * Returns true if plugin is enabled.
     * 
     * @param plugin
     *            plugin
     * @return true if enabled
     * @see PluginStateResolver#isEnabled(Plugin)
     */
    public static boolean isEnabled(final Plugin plugin) {
        return PluginUtilsService.isEnabled(plugin);
    }

    /**
     * Returns true if plugin is enabled.
     * 
     * @param pluginIdentifier
     *            plugin's identifier
     * @return true if enabled
     * @see PluginStateResolver#isEnabled(String)
     */
    public static boolean isEnabled(final String pluginIdentifier) {
        return PluginUtilsService.isEnabled(pluginIdentifier);
    }

    /**
     * Returns true if plugin is enabled or enabling.
     * 
     * @deprecated for internal use only
     * 
     * @param plugin
     *            plugin
     * @return true if enabled or enabling
     * @see PluginStateResolver#isEnabledOrEnabling(Plugin)
     */
    @Deprecated
    public static boolean isEnabledOrEnabling(final Plugin plugin) {
        return PluginUtilsService.isEnabledOrEnabling(plugin);
    }

    /**
     * Returns true if plugin is enabled or enabling.
     * 
     * @deprecated for internal use only
     * 
     * @param pluginIdentifier
     *            plugin's identifier
     * @return true if enabled or enabling
     * @see PluginStateResolver#isEnabledOrEnabling(Plugin)
     */
    @Deprecated
    public static boolean isEnabledOrEnabling(final String pluginIdentifier) {
        return PluginUtilsService.isEnabledOrEnabling(pluginIdentifier);
    }

}