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
|
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact 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.task;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import java.util.regex.Pattern;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.batch.ScannerSide;
import org.sonar.api.batch.InstantiationStrategy;
/**
* Register and describe a {@link TaskExtension}.
*
* @since 3.6
*/
@ExtensionPoint
@ScannerSide
@InstantiationStrategy(InstantiationStrategy.PER_TASK)
public class TaskDefinition implements Comparable<TaskDefinition> {
static final String KEY_PATTERN = "[a-zA-Z0-9\\-\\_]+";
private final String key;
private final String description;
private final Class<? extends Task> taskClass;
private TaskDefinition(Builder builder) {
this.key = builder.key;
this.description = builder.description;
this.taskClass = builder.taskClass;
}
public String description() {
return description;
}
public String key() {
return key;
}
public Class<? extends Task> taskClass() {
return taskClass;
}
@Override
public String toString() {
return "Task " + key + "[class=" + taskClass.getName() + ", desc=" + description + "]";
}
public static Builder builder() {
return new Builder();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
TaskDefinition that = (TaskDefinition) o;
return key.equals(that.key);
}
@Override
public int hashCode() {
return key.hashCode();
}
@Override
public int compareTo(TaskDefinition o) {
return key.compareTo(o.key);
}
public static class Builder {
private String key;
private String description;
private Class<? extends Task> taskClass;
private Builder() {
}
public Builder key(String key) {
this.key = key;
return this;
}
public Builder description(String s) {
this.description = s;
return this;
}
public Builder taskClass(Class<? extends Task> taskClass) {
this.taskClass = taskClass;
return this;
}
public TaskDefinition build() {
Preconditions.checkArgument(!Strings.isNullOrEmpty(key), "Task key must be set");
Preconditions.checkArgument(Pattern.matches(KEY_PATTERN, key), "Task key '" + key + "' must match " + KEY_PATTERN);
Preconditions.checkArgument(!Strings.isNullOrEmpty(description), "Description must be set for task '" + key + "'");
Preconditions.checkArgument(taskClass != null, "Class must be set for task '" + key + "'");
return new TaskDefinition(this);
}
}
}
|
