xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/index/PendingFileDeletion.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, Chris Fraire <cfraire@me.com>.
22  */
23 package org.opengrok.indexer.index;
24 
25 /**
26  * Represents the metadata for a pending file deletion.
27  */
28 public final class PendingFileDeletion {
29     private final String absolutePath;
30 
PendingFileDeletion(String absolutePath)31     public PendingFileDeletion(String absolutePath) {
32         this.absolutePath = absolutePath;
33     }
34 
35     /**
36      * @return the absolute path
37      */
getAbsolutePath()38     public String getAbsolutePath() {
39         return absolutePath;
40     }
41 
42     /**
43      * Compares {@code absolutePath} to the other object's value.
44      * @param o other object for comparison
45      * @return {@code true} if the two compared objects are identical;
46      * otherwise false
47      */
48     @Override
equals(Object o)49     public boolean equals(Object o) {
50         if (!(o instanceof PendingFileDeletion)) {
51             return false;
52         }
53         PendingFileDeletion other = (PendingFileDeletion) o;
54         return this.absolutePath.equals(other.absolutePath);
55     }
56 
57     @Override
hashCode()58     public int hashCode() {
59         return this.absolutePath.hashCode();
60     }
61 }
62