Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: ddb976e29dc1cabf46e56d67f653539a16bac920 (plain) (blame)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*******************************************************************************
 * Copyright (c) 2009, 2012 Alena Laskavaia
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Alena Laskavaia  - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.codan.internal.core.model;

import org.eclipse.cdt.codan.core.model.CodanSeverity;
import org.eclipse.cdt.codan.core.model.IProblemMultiple;
import org.eclipse.cdt.codan.core.model.IProblemReporter;
import org.eclipse.cdt.codan.core.model.IProblemWorkingCopy;
import org.eclipse.cdt.codan.core.param.IProblemPreference;
import org.eclipse.cdt.codan.internal.core.CheckersRegistry;

/**
 * A type of problems reported by Codan.
 */
public class CodanProblem extends CodanProblemElement implements IProblemWorkingCopy, Cloneable, IProblemMultiple {
	private String id;
	private String name;
	private String messagePattern;
	private CodanSeverity severity = CodanSeverity.Warning;
	private boolean enabled = true;
	private IProblemPreference rootPreference;
	private String description;
	private String markerType = IProblemReporter.GENERIC_CODE_ANALYSIS_MARKER_TYPE;
	private boolean multiple;

	public void setMultiple(boolean multiple) {
		this.multiple = multiple;
	}

	@Override
	public CodanSeverity getSeverity() {
		return severity;
	}

	/**
	 * @param problemId - the ID of the problem
	 * @param name - the name of the problem
	 */
	public CodanProblem(String problemId, String name) {
		this.id = problemId;
		this.name = name;
	}

	@Override
	public String getName() {
		return name;
	}

	@Override
	public String getId() {
		return id;
	}

	/**
	 * @param id
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public void setId(String id) {
		this.id = id;
	}

	@Override
	public String toString() {
		return name;
	}

	@Override
	public boolean isEnabled() {
		return enabled;
	}

	@Override
	public void setSeverity(CodanSeverity sev) {
		if (sev == null)
			throw new NullPointerException();
		checkSet();
		this.severity = sev;
	}

	@Override
	public void setEnabled(boolean checked) {
		checkSet();
		this.enabled = checked;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see java.lang.Object#clone()
	 */
	@Override
	public Object clone() {
		CodanProblem prob;
		prob = (CodanProblem) super.clone();
		if (rootPreference != null) {
			prob.rootPreference = (IProblemPreference) rootPreference.clone();
		}
		return prob;
	}

	@Override
	public void setPreference(IProblemPreference value) {
		if (value == null)
			throw new NullPointerException();
		rootPreference = value;
	}

	@Override
	public IProblemPreference getPreference() {
		return rootPreference;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.cdt.codan.core.model.IProblem#getMessagePattern()
	 */
	@Override
	public String getMessagePattern() {
		return messagePattern;
	}

	/**
	 * @param messagePattern
	 *        the message to set
	 */
	@Override
	public void setMessagePattern(String messagePattern) {
		checkSet();
		this.messagePattern = messagePattern;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.cdt.codan.core.model.IProblem#getDescription()
	 */
	@Override
	public String getDescription() {
		return description;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see
	 * org.eclipse.cdt.codan.core.model.IProblemWorkingCopy#setDescription(java
	 * .lang.String)
	 */
	@Override
	public void setDescription(String desc) {
		checkSet();
		this.description = desc;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.cdt.codan.core.model.IProblem#getMarkerType()
	 */
	@Override
	public String getMarkerType() {
		return markerType;
	}

	/**
	 * Sets the marker id for the problem.
	 *
	 * @param markerType
	 */
	public void setMarkerType(String markerType) {
		checkSet();
		this.markerType = markerType;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.cdt.codan.core.model.IProblemMultiple#isMultiple()
	 */
	@Override
	public boolean isMultiple() {
		return multiple;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.cdt.codan.core.model.IProblemMultiple#isOriginal()
	 */
	@Override
	public boolean isOriginal() {
		return !id.contains(CheckersRegistry.CLONE_SUFFIX);
	}
}

Back to the top