xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/index/PendingFileRenaming.java (revision 5d9f3aa0ca3da3a714233f987fa732f62c0965f6)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * See LICENSE.txt included in this distribution for the specific
9  * language governing permissions and limitations under the License.
10  *
11  * When distributing Covered Code, include this CDDL HEADER in each
12  * file and include the License file at LICENSE.txt.
13  * If applicable, add the following below this CDDL HEADER, with the
14  * fields enclosed by brackets "[]" replaced with your own identifying
15  * information: Portions Copyright [yyyy] [name of copyright owner]
16  *
17  * CDDL HEADER END
18  */
19 
20 /*
21  * Copyright (c) 2017, 2018, Chris Fraire <cfraire@me.com>.
22  */
23 package org.opengrok.indexer.index;
24 
25 /**
26  * Represents the metadata for a pending file renaming.
27  */
28 public final class PendingFileRenaming {
29     private final String absolutePath;
30     private final String transientPath;
31 
PendingFileRenaming(String absolutePath, String transientPath)32     public PendingFileRenaming(String absolutePath, String transientPath) {
33         this.absolutePath = absolutePath;
34         this.transientPath = transientPath;
35     }
36 
37     /**
38      * @return the final, absolute path
39      */
getAbsolutePath()40     public String getAbsolutePath() {
41         return absolutePath;
42     }
43 
44     /**
45      * @return the transient, absolute path
46      */
getTransientPath()47     public String getTransientPath() {
48         return transientPath;
49     }
50 
51     /**
52      * Compares {@code absolutePath} to the other object's value.
53      * @param o other object for comparison
54      * @return {@code true} if the two compared objects are identical;
55      * otherwise false
56      */
57     @Override
equals(Object o)58     public boolean equals(Object o) {
59         if (!(o instanceof PendingFileRenaming)) {
60             return false;
61         }
62         PendingFileRenaming other = (PendingFileRenaming) o;
63         return this.absolutePath.equals(other.absolutePath);
64     }
65 
66     @Override
hashCode()67     public int hashCode() {
68         return this.absolutePath.hashCode();
69     }
70 }
71