summaryrefslogtreecommitdiffstats
path: root/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java
blob: bbab3139dd8f83cf816cd4ffda72e96e57957cd0 (plain)
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
/*******************************************************************************
 * 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;

import java.util.Collection;

/**
 * Interface representing code analysis problem
 *
 */
public interface IProblem extends IProblemElement {
	/**
	 * Name of the problem - user visible "title", not the message
	 */
	String getName();

	/**
	 * Unique problem id. Should be qualified by plugin name to maintain uniqueness. 
	 * @return
	 */
	String getId();

	/**
	 * Is enabled in current context (usually within profile)
	 * @return true if enabled
	 */
	boolean isEnabled();

	/**
	 * Get current severity
	 * @return severity
	 */
	CodanSeverity getSeverity();

	/**
	 * Message pattern, java patter like 'Variable {0} is never used here'
	 * @return pattern 
	 */
	String getMessagePattern();

	void setSeverity(CodanSeverity sev);

	void setEnabled(boolean checked);

	void setMessagePattern(String message);

	public void setProperty(Object key, Object value);

	/**
	 * Get custom property
	 * @param property name
	 * @return property object
	 */
	public Object getProperty(Object key);

	public Collection<Object> getPropertyKeys();
}