Skip to main content
summaryrefslogtreecommitdiffstats
blob: 9dc465e9b220ec98cb0c19708c0bec67dc86daef (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
/*******************************************************************************
 * Copyright (c) 2009 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.core.model;

/**
 * Problem Profile contains tree of categories and problems. Profiles can have
 * different categories and different problems set, problems with the same id
 * can have different severities/enablement in different profiles. To obtain
 * profile use class {@link CheckersRegisry#getResourceProfile,
 * CheckersRegisry#getDefaultProfile() or CheckersRegisry#getWorkspaceProfile()}
 * .
 * 
 */
public interface IProblemProfile extends IProblemElement {
	/**
	 * @return root category in profile
	 */
	IProblemCategory getRoot();

	/**
	 * Find and return problem by id
	 * 
	 * @param id
	 *            - problem id
	 * @return problem instance
	 */
	IProblem findProblem(String id);

	/**
	 * Find and return category by id
	 * 
	 * @param id
	 *            - category id
	 * @return category instance
	 */
	IProblemCategory findCategory(String id);

	/**
	 * Get all defined problems
	 * 
	 * @return array of problems defined in profile
	 */
	IProblem[] getProblems();
}

Back to the top