org.aposin.licensescout.archive.ArchiveIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of licensescout-maven-plugin Show documentation

Maven plug-in using the LicenseScout Core for standard Maven builds. Can write reports as CSV, Text or HTML using configurable templates and can write results to a database.

There is a newer version: 1.4.0.RC28

Show newest version

/**
 * Copyright 2019 Association for the promotion of open-source insurance software and for the establishment of open interface standards in the insurance industry (Verein zur Förderung quelloffener Versicherungssoftware und Etablierung offener Schnittstellenstandards in der Versicherungsbranche)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.aposin.licensescout.archive;

import java.util.Objects;

/**
 * Base class for Identifier for an archive bases on name.
 * 
 * An archive can be identified either by:
 * 
 * Name and version ({@link ArchiveIdentifierVersion})
 * Name and message digest ({@link ArchiveIdentifierMessageDigest})
 * Regular expression on either the name or the path ({@link ArchiveIdentifierPattern})
 * 
 * 
 * @see ArchiveIdentifierVersion
 * @see ArchiveIdentifierMessageDigest
 * @see ArchiveIdentifierPattern
 */
public abstract class ArchiveIdentifier {

    private final ArchiveType archiveType;
    private final NameMatchingType nameMatchingType;
    private final String name;

    /**
     * Constructor.
     * 
     * @param archiveType type of the archive
     * @param name
     */
    protected ArchiveIdentifier(final ArchiveType archiveType, final NameMatchingType nameMatchingType,
            final String name) {
        super();
        this.archiveType = archiveType;
        this.nameMatchingType = nameMatchingType;
        this.name = name;
    }

    /**
     * @return the archiveType
     */
    public final ArchiveType getArchiveType() {
        return archiveType;
    }

    /**
     * @return the nameMatchingType
     */
    public final NameMatchingType getNameMatchingType() {
        return nameMatchingType;
    }

    /**
     * @return the name
     */
    public final String getName() {
        return name;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) { return true; }
        if (!(o instanceof ArchiveIdentifier)) { return false; }
        ArchiveIdentifier that = (ArchiveIdentifier) o;
        return getArchiveType() == that.getArchiveType() &&
            getNameMatchingType() == that.getNameMatchingType() &&
            Objects.equals(getName(), that.getName());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getArchiveType(), getNameMatchingType(), getName());
    }
}