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
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2013 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.
*/
package org.sonar.api.violations;
import org.sonar.api.resources.Resource;
/**
* Class that allows to query the Sonar index about violations.
*
* @since 2.8
* @deprecated in 3.6 for the merge of violations and reviews into issues.
*/
@Deprecated
public final class ViolationQuery {
public static enum SwitchMode {
OFF, ON, BOTH
}
private SwitchMode switchMode = SwitchMode.ON;
private Resource resource;
/**
* Use the factory method <code>create()</code>
*/
ViolationQuery() {
}
/**
* Creates a new {@link ViolationQuery} object.
*
* @return the new query
*/
public static ViolationQuery create() {
return new ViolationQuery();
}
/**
* Specifies if the query should return only switched-off violations.
*
* @param b
* if true, the query will return only switched-off violations. if false, it will return only active violations.
* @return the current violation query
*/
public ViolationQuery setSwitchedOff(boolean b) {
this.switchMode = (b ? SwitchMode.OFF : SwitchMode.ON);
return this;
}
/**
* Tells if the query should return only switched-off violations.
*
* @return
*/
public boolean isSwitchedOff() {
return switchMode == SwitchMode.OFF;
}
public SwitchMode getSwitchMode() {
return switchMode;
}
public ViolationQuery setSwitchMode(SwitchMode s) {
this.switchMode = s;
return this;
}
/**
* Specifies the resource which violations are search from.
*
* @param resource
* the resource
*/
public ViolationQuery forResource(Resource resource) {
this.resource = resource;
return this;
}
/**
* Returns the resource which violations are search from.
*
* @return the resource
*/
public Resource getResource() {
return resource;
}
}
|
