xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/index/PendingSymlinkage.java (revision 5d9f3aa0ca3da3a714233f987fa732f62c0965f6)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2017, 2018, Chris Fraire <cfraire@me.com>.
 */
package org.opengrok.indexer.index;

/**
 * Represents the metadata for a pending symbolic linkage.
 */
public final class PendingSymlinkage {
    private final String sourcePath;
    private final String targetRelPath;

    public PendingSymlinkage(String sourcePath, String targetRelPath) {
        this.sourcePath = sourcePath;
        this.targetRelPath = targetRelPath;
    }

    /**
     * @return the source, absolute path
     */
    public String getSourcePath() {
        return sourcePath;
    }

    /**
     * @return the target, relative path
     */
    public String getTargetRelPath() {
        return targetRelPath;
    }

    /**
     * Compares {@code sourcePath} to the other object's value.
     * @param o other object for comparison
     * @return {@code true} if the two compared objects are identical;
     * otherwise false
     */
    @Override
    public boolean equals(Object o) {
        if (!(o instanceof PendingSymlinkage)) {
            return false;
        }
        PendingSymlinkage other = (PendingSymlinkage) o;
        return this.sourcePath.equals(other.sourcePath);
    }

    @Override
    public int hashCode() {
        return this.sourcePath.hashCode();
    }
}