org.craftercms.commons.plugin.model.PluginDescriptor Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2007-2020 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public Link as published by
 * the Free Software Foundation, either version 3 of the Link, or
 *
 * 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 General Public Link for more details.
 *
 * You should have received a copy of the GNU General Public Link
 * along with this program.  If not, see .
 */

package org.craftercms.commons.plugin.model;

import java.util.Objects;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

/**
 * Holds all the metadata for a plugin
 *
 * @author joseross
 * @since 3.1.1
 */
@SuppressWarnings("deprecation")
@JsonIgnoreProperties(ignoreUnknown = true)
public class PluginDescriptor {

    /**
     * The version of the descriptor
     */
    protected String descriptorVersion = "2";

    /**
     * The actual metadata of the plugin
     */
    protected Plugin plugin;

    /**
     * Used by a previous version, kept for backwards compatibility
     */
    protected BlueprintDescriptor.Blueprint blueprint;

    public String getDescriptorVersion() {
        return descriptorVersion;
    }

    public void setDescriptorVersion(String descriptorVersion) {
        this.descriptorVersion = descriptorVersion;
    }

    public Plugin getPlugin() {
        return plugin;
    }

    public void setPlugin(final Plugin plugin) {
        this.plugin = plugin;
    }

    @Deprecated
    @JsonIgnore
    public BlueprintDescriptor.Blueprint getBlueprint() {
        return blueprint;
    }

    public void setBlueprint(BlueprintDescriptor.Blueprint plugin) {
        this.blueprint = plugin;
    }

    /**
     * Wraps the plugin metadata in a descriptor object
     * @param plugin the plugin to wrap
     * @return the plugin descriptor
     */
    public static PluginDescriptor of(Plugin plugin) {
        PluginDescriptor descriptor = new PluginDescriptor();
        descriptor.setPlugin(plugin);
        return descriptor;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof PluginDescriptor)) {
            return false;
        }
        final PluginDescriptor that = (PluginDescriptor)o;
        return Objects.equals(descriptorVersion, that.descriptorVersion) && Objects.equals(plugin, that.plugin);
    }

    @Override
    public int hashCode() {
        return Objects.hash(descriptorVersion, plugin);
    }

    @Override
    public String toString() {
        return "PluginDescriptor{" + "descriptorVersion='" + descriptorVersion + '\'' + ", plugin=" + plugin + '}';
    }

}