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
|
/*
* SonarQube
* Copyright (C) 2009-2019 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program 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.
*
* This program 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.
*/
package org.sonar.api.rule;
import com.google.common.base.Preconditions;
import java.io.Serializable;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import static org.apache.commons.lang.StringUtils.isEmpty;
/**
* Key of a rule. Unique among all the rule repositories.
*
* @since 3.6
*/
@Immutable
public class RuleKey implements Serializable, Comparable<RuleKey> {
public static final String EXTERNAL_RULE_REPO_PREFIX = "external_";
private final String repository;
private final String rule;
private final String toString;
protected RuleKey(String repositoryKey, String ruleKey) {
this.repository = repositoryKey;
this.rule = ruleKey;
this.toString = repositoryKey + ":" + ruleKey;
}
/**
* Create a key. Parameters are NOT null.
*/
public static RuleKey of(String repository, String rule) {
Preconditions.checkArgument(!isEmpty(repository), "Repository must be set");
Preconditions.checkArgument(!isEmpty(rule), "Rule must be set");
return new RuleKey(repository, rule);
}
/**
* Create a key from a string representation (see {@link #toString()}. An {@link IllegalArgumentException} is raised
* if the format is not valid.
*/
public static RuleKey parse(String s) {
int semiColonPos = s.indexOf(':');
Preconditions.checkArgument(semiColonPos > 0, "Invalid rule key: " + s);
String key = s.substring(0, semiColonPos);
String repo = s.substring(semiColonPos + 1);
return RuleKey.of(key, repo);
}
/**
* Never null
*/
public String repository() {
return repository;
}
/**
* Never null
*/
public String rule() {
return rule;
}
@Override
public boolean equals(@Nullable Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
RuleKey ruleKey = (RuleKey) o;
return repository.equals(ruleKey.repository) && rule.equals(ruleKey.rule);
}
@Override
public int hashCode() {
int result = repository.hashCode();
result = 31 * result + rule.hashCode();
return result;
}
/**
* Format is "repository:rule", for example "squid:AvoidCycle"
*/
@Override
public String toString() {
return toString;
}
@Override
public int compareTo(RuleKey o) {
int compareRepositories = this.repository.compareTo(o.repository);
if (compareRepositories == 0) {
return this.rule.compareTo(o.rule);
}
return compareRepositories;
}
}
|
