PluginDependencyInformation.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;

/**
 * Plugin's requirements. It holds required plugin's identifier and optionally required version.
 * 
 * @since 0.4.0
 */
public class PluginDependencyInformation {

    private final String identifier;

    private final VersionOfDependency version;

    /**
     * Creates requirement for plugin with given identifier, no required version provided.
     * 
     * @param identifier
     *            required plugin's identifier
     */
    public PluginDependencyInformation(final String identifier) {
        this(identifier, new VersionOfDependency(""));
    }

    /**
     * Creates requirement for plugin with given identifier and version.
     * 
     * @param identifier
     *            required plugin's identifier
     * @param version
     *            required plugin's version
     */
    public PluginDependencyInformation(final String identifier, final VersionOfDependency version) {
        this.identifier = identifier;
        this.version = version;
    }

    /**
     * Returns required plugin's identifier.
     * 
     * @return required plugin's identifier
     */
    public String getIdentifier() {
        return identifier;
    }

    /**
     * Returns required plugin's version
     * 
     * @return required plugin's version
     */
    public VersionOfDependency getVersionOfDependency() {
        return version;
    }

    /**
     * Returns true if the required plugin's version contains the given one.
     * 
     * @param version
     *            version
     * @return true if the required plugin's version contains the given one
     */
    public boolean contains(final Version version) {
        return this.version.contains(version);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return identifier + " " + version;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((identifier == null) ? 0 : identifier.hashCode());
        result = prime * result + ((version == null) ? 0 : version.hashCode());
        return result;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof PluginDependencyInformation)) {
            return false;
        }
        PluginDependencyInformation other = (PluginDependencyInformation) obj;
        if (identifier == null) {
            if (other.identifier != null) {
                return false;
            }
        } else if (!identifier.equals(other.identifier)) {
            return false;
        }
        if (version == null) {
            if (other.version != null) {
                return false;
            }
        } else if (!version.equals(other.version)) {
            return false;
        }
        return true;
    }

}