org.codehaus.mojo.license.download.ProjectLicense Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of license-maven-plugin Show documentation
Maven plugin to download and collect license files from project dependencies.
There is a newer version: 2.4.0
package org.codehaus.mojo.license.download;

/*
 * #%L
 * License Maven Plugin
 * %%
 * Copyright (C) 2018 Codehaus
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import org.apache.maven.model.License;

/**
 * The license subelement of {@link ProjectLicenseInfo}.
 *
 * @since 1.17
 */
public class ProjectLicense implements Cloneable
{


    /**
     * The full legal name of the license.
     */
    private String name;

    /**
     * The official url for the license text.
     */
    private String url;

    /**
     *
     *
     *             The primary method by which this project may be
     * distributed.
     *             
     *               repo
     *               may be downloaded from the Maven
     * repository
     *               manual
     *               user must manually download and install
     * the dependency.
     *             
     *
     *
     */
    private String distribution;

    /**
     * Addendum information pertaining to this license.
     */
    private String comments;

    /**
     * A name of the license file (without path) downloaded from {@link #url}.
     */
    private String file;

    /**
     * The default constructor.
     */
    public ProjectLicense()
    {
    }

    /**
     * Equivalent to {@code new ProjectLicense( license.getName(), license.getUrl(), license.getDistribution(),
     * license.getComments(), null )}
     *
     * @param license the license to get name, URL, ditribution and comments from
     */
    public ProjectLicense( License license )
    {
        this( license.getName(), license.getUrl(), license.getDistribution(), license.getComments(), null );
    }

    /**
     * The full constructor.
     *
     * @param name a human readable license name
     * @param url a URL from where the license text can be downloaded
     * @param distribution see {@link #getDistribution()}
     * @param comments additional information related to this license
     * @param file file name without path
     */
    public ProjectLicense( String name, String url, String distribution, String comments, String file )
    {
        super();
        this.name = name;
        this.url = url;
        this.distribution = distribution;
        this.comments = comments;
        this.file = file;
    }

    /**
     * Get addendum information pertaining to this license.
     *
     * @return String
     */
    public String getComments()
    {
        return this.comments;
    }

    /**
     * Get the primary method by which this project may be
     * distributed.
     *             
     *               repo
     *               may be downloaded from the Maven
     * repository
     *               manual
     *               user must manually download and install
     * the dependency.
     *             
     *
     * @return String
     */
    public String getDistribution()
    {
        return this.distribution;
    }

    /**
     * Get the full legal name of the license.
     *
     * @return String
     */
    public String getName()
    {
        return this.name;
    }

    /**
     * Get the official url for the license text.
     *
     * @return String
     */
    public String getUrl()
    {
        return this.url;
    }

    /**
     * Returns the name of the license file (without path) downloaded from {@link #url}.
     *
     * @return a path or {@code null}
     */
    public String getFile()
    {
        return this.file;
    }

    /**
     * Set addendum information pertaining to this license.
     *
     * @param comments
     */
    public void setComments( String comments )
    {
        this.comments = comments;
    }

    /**
     * Set the primary method by which this project may be
     * distributed.
     *             
     *               repo
     *               may be downloaded from the Maven
     * repository
     *               manual
     *               user must manually download and install
     * the dependency.
     *             
     *
     * @param distribution
     */
    public void setDistribution( String distribution )
    {
        this.distribution = distribution;
    }

    /**
     * Set the full legal name of the license.
     *
     * @param name
     */
    public void setName( String name )
    {
        this.name = name;
    }

    /**
     * Set the official url for the license text.
     *
     * @param url
     */
    public void setUrl( String url )
    {
        this.url = url;
    }

    /**
     * Set the name of the license file (without path) downloaded from {@link #url}.
     *
     * @param file the path to set
     */
    public void setFile( String file )
    {
        this.file = file;
    }

    @Override
    public ProjectLicense clone()
        throws CloneNotSupportedException
    {
        return (ProjectLicense) super.clone();
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ( ( comments == null ) ? 0 : comments.hashCode() );
        result = prime * result + ( ( distribution == null ) ? 0 : distribution.hashCode() );
        result = prime * result + ( ( file == null ) ? 0 : file.hashCode() );
        result = prime * result + ( ( name == null ) ? 0 : name.hashCode() );
        result = prime * result + ( ( url == null ) ? 0 : url.hashCode() );
        return result;
    }

    @Override
    public boolean equals( Object obj )
    {
        // CHECKSTYLE_OFF: NeedBraces
        if ( this == obj )
            return true;
        if ( obj == null )
            return false;
        if ( getClass() != obj.getClass() )
            return false;
        ProjectLicense other = (ProjectLicense) obj;
        if ( comments == null )
        {
            if ( other.comments != null )
                return false;
        }
        else if ( !comments.equals( other.comments ) )
            return false;
        if ( distribution == null )
        {
            if ( other.distribution != null )
                return false;
        }
        else if ( !distribution.equals( other.distribution ) )
            return false;
        if ( file == null )
        {
            if ( other.file != null )
                return false;
        }
        else if ( !file.equals( other.file ) )
            return false;
        if ( name == null )
        {
            if ( other.name != null )
                return false;
        }
        else if ( !name.equals( other.name ) )
            return false;
        if ( url == null )
        {
            if ( other.url != null )
                return false;
        }
        else if ( !url.equals( other.url ) )
            return false;
        return true;
        // CHECKSTYLE_ON: NeedBraces
    }

}