aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-duplications/src/main/java/net/sourceforge/pmd/cpd/TokenEntry.java
blob: 5a45dcf2623a02ed23c85eb7748a85992afd7ca5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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 this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */
package net.sourceforge.pmd.cpd;

import com.google.common.annotations.Beta;

import java.util.HashMap;
import java.util.Map;

/**
 * @since 2.2
 */
public class TokenEntry implements Comparable<TokenEntry> {

  private static final Map<String, Integer> TOKENS = new HashMap<String, Integer>();
  private static int tokenCount = 0;

  /**
   * Shared instance of end-of-file token.
   *
   * <p>Not intended to be used by clients - {@link #getEOF()} should be used instead.</p>
   */
  public static final TokenEntry EOF = new TokenEntry();

  private String tokenSrcID;
  private int beginLine;
  private int index;
  private int identifier;
  private int hashCode;

  private final String value;

  private TokenEntry() {
    this.identifier = 0;
    this.tokenSrcID = "EOFMarker";
    this.value = "";
  }

  /**
   * @param image string representation of token
   * @param tokenSrcID within Sonar Ecosystem - absolute path to file, otherwise current implementation of sonar-cpd-plugin will not work
   * @param beginLine number of line
   */
  public TokenEntry(String image, String tokenSrcID, int beginLine) {
    Integer i = TOKENS.get(image);
    if (i == null) {
      i = TOKENS.size() + 1;
      TOKENS.put(image, i);
    }
    this.identifier = i.intValue();
    this.tokenSrcID = tokenSrcID;
    this.beginLine = beginLine;
    this.index = tokenCount++;
    this.value = image;
  }

  /**
   * For internal use only.
   *
   * @since 2.14
   */
  @Beta
  public String getValue() {
    return value;
  }

  /**
   * End-of-file token.
   */
  public static TokenEntry getEOF() {
    tokenCount++;
    return EOF;
  }

  public static void clearImages() {
    TOKENS.clear();
    tokenCount = 0;
  }

  public String getTokenSrcID() {
    return tokenSrcID;
  }

  public int getBeginLine() {
    return beginLine;
  }

  public int getIdentifier() {
    return this.identifier;
  }

  public int getIndex() {
    return this.index;
  }

  @Override
  public int hashCode() {
    return hashCode;
  }

  public void setHashCode(int hashCode) {
    this.hashCode = hashCode;
  }

  @Override
  public boolean equals(Object o) {
    if (!(o instanceof TokenEntry)) {
      return false;
    }
    TokenEntry other = (TokenEntry) o;
    return other.hashCode == hashCode;
  }

  @Override
  public int compareTo(TokenEntry other) {
    return getIndex() - other.getIndex();
  }
}