org.jfree.base.Library Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jtstand-common Show documentation
jtstand-common is a library derived from jcommon, used by jtstand-chart, which is derived from jfreechart
There is a newer version: 1.5.9
/*
 * Copyright (c) 2009 Albert Kurucz. 
 *
 * This file, Library.java is part of JTStand.
 *
 * JTStand 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.
 *
 * JTStand 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with GTStand.  If not, see .
 */

package org.jfree.base;

import org.jfree.ui.about.AboutFrame;

/**
 * A simple class representing a library in a software project.  For use in
 * the {@link AboutFrame} class.
 *
 * @author David Gilbert
 */
public class Library {

    /** The name. */
    private String name;

    /** The version. */
    private String version;

    /** The licenceName. */
    private String licenceName;

    /** The version. */
    private String info;

    /**
     * Creates a new library reference.
     *
     * @param name  the name.
     * @param version  the version.
     * @param licence  the licenceName.
     * @param info  the web address or other info.
     */
    public Library(final String name, final String version,
                   final String licence, final String info) {

        this.name = name;
        this.version = version;
        this.licenceName = licence;
        this.info = info;
    }

    /**
     * Creates a new library reference.
     */
    protected Library() {
        // nothing required
    }

    /**
     * Returns the library name.
     *
     * @return the library name.
     */
    public String getName() {
        return this.name;
    }

    /**
     * Returns the library version.
     *
     * @return the library version.
     */
    public String getVersion() {
        return this.version;
    }

    /**
     * Returns the licenceName text.
     *
     * @return the licenceName text.
     */
    public String getLicenceName() {
        return this.licenceName;
    }

    /**
     * Returns the project info for the library.
     *
     * @return the project info.
     */
    public String getInfo() {
        return this.info;
    }

    /**
     * Sets the project info.
     *
     * @param info  the project info.
     */
    protected void setInfo(final String info) {
        this.info = info;
    }

    /**
     * Sets the licence name.
     *
     * @param licenceName  the licence name.
     */
    protected void setLicenceName(final String licenceName) {
        this.licenceName = licenceName;
    }

    /**
     * Sets the project name.
     *
     * @param name  the project name.
     */
    protected void setName(final String name) {
        this.name = name;
    }

    /**
     * Sets the version identifier.
     *
     * @param version  the version identifier.
     */
    protected void setVersion(final String version) {
        this.version = version;
    }

    /**
     * Tests this object for equality with an arbitrary object.
     *
     * @param o  the object.
     *
     * @return A boolean.
     */
    public boolean equals(final Object o)
    {
      if (this == o)
      {
        return true;
      }
      if (o == null || getClass() != o.getClass())
      {
        return false;
      }

      final Library library = (Library) o;

      if (this.name != null ? !this.name.equals(library.name) : library.name != null)
      {
        return false;
      }

      return true;
    }

    /**
     * Returns a hash code for this instance.
     *
     * @return A hash code.
     */
    public int hashCode()
    {
      return (this.name != null ? this.name.hashCode() : 0);
    }
}