TclCheckerProblem.java

/*******************************************************************************
 * Copyright (c) 2005, 2017 IBM Corporation and others.
 * 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
 *
 *******************************************************************************/
package org.eclipse.dltk.tcl.internal.tclchecker;

import java.util.HashMap;
import java.util.Map;

import org.eclipse.dltk.tcl.tclchecker.model.messages.CheckerMessage;

public class TclCheckerProblem {
	private final String file;
	private final int lineNumber;
	private final CheckerMessage description;
	private final String messageId;
	private final String messageText;
	private CoordRange range;
	private CoordRange errorRange;
	private Map<String, Object> attributes = null;

	public TclCheckerProblem(String source, int lineNumber, String messageID, String message) {
		this.file = source;
		this.lineNumber = lineNumber;
		this.description = TclCheckerProblemDescription.getProblem(messageID);
		this.messageId = messageID;
		this.messageText = message;
	}

	public String getFile() {
		return file;
	}

	public int getLineNumber() {
		return lineNumber;
	}

	public String getMessage() {
		return "(" + messageId + ") " + messageText; //$NON-NLS-1$ //$NON-NLS-2$
	}

	@Override
	public String toString() {
		return file + ":" + lineNumber + " " + description; //$NON-NLS-1$ //$NON-NLS-2$
	}

	public CoordRange getRange() {
		return range;
	}

	public void setRange(CoordRange range) {
		this.range = range;
	}

	public CoordRange getErrorRange() {
		return errorRange;
	}

	public void setErrorRange(CoordRange range) {
		this.errorRange = range;
	}

	/**
	 * Returns map of attributes of <code>null</code> if there are no attributes
	 * yet
	 *
	 * @return the attributes
	 */
	public Map<String, Object> getAttributes() {
		return attributes;
	}

	/**
	 * @param name
	 * @param value
	 */
	public void addAttribute(String name, String value) {
		if (attributes == null) {
			attributes = new HashMap<>();
		}
		if (value != null) {
			attributes.put(name, value);
		} else {
			attributes.remove(name);
		}
	}

	/**
	 * @param name
	 * @param value
	 */
	public void addAttribute(String name, int value) {
		if (attributes == null) {
			attributes = new HashMap<>();
		}
		attributes.put(name, value);
	}

	/**
	 * @return
	 */
	public boolean isError() {
		return description.getCategory().isError();
	}

	/**
	 * @return
	 */
	public boolean isWarning() {
		return description.getCategory().isWarning();
	}

	/**
	 * @return
	 */
	public String getExplanation() {
		return description.getExplanation();
	}

}