org.eclipse.xtext.validation.AbstractValidationDiagnostic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.xtend.standalone Show documentation
There is a newer version: 2.4.3
Show newest version
/*******************************************************************************
 * Copyright (c) 2011 itemis AG (http://www.itemis.eu) 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.xtext.validation;

import java.util.Collections;
import java.util.List;

import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.xtext.util.Arrays;
import org.eclipse.xtext.util.EmfFormatter;

/**
 * @author Sebastian Zarnekow - Initial contribution and API
 */
public abstract class AbstractValidationDiagnostic implements Diagnostic {

	private final String message;
	private final EObject source;
	private final int severity;
	private final CheckType checkType;
	private final String issueCode;
	private final String[] issueData;
	
	/**
	 * @param issueData optional user data. May not contain null entries.
	 */
	protected AbstractValidationDiagnostic(int severity, String message, EObject source, CheckType checkType, String issueCode, String... issueData) {
		if (Arrays.contains(issueData, null)) {
			throw new NullPointerException("issueData may not contain null");
		}
		this.source = source;
		this.severity = severity;
		this.message = message;
		this.issueCode = issueCode;
		this.checkType = checkType;
		this.issueData = issueData;
	}
	
	public List getChildren() {
		return Collections.emptyList();
	}

	// it turns out, the EMF Diagnostic works well with 0,
	// look at getIssueCode() to retrieve the string-based
	// code
	public int getCode() {
		return 0;
	}
	
	public String getSource() {
		return source == null ? "" : source.toString();
	}
	
	public EObject getSourceEObject() {
		return source;
	}
	
	public Throwable getException() {
		return null;
	}

	public String getMessage() {
		return message;
	}

	public int getSeverity() {
		return severity;
	}
	
	public String getIssueCode() {
		return issueCode;
	}
	
	public String[] getIssueData() {
		return issueData;
	}
	
	public CheckType getCheckType() {
		return checkType;
	}
	
	@Override
	public String toString() {
		StringBuilder result = new StringBuilder();
		result.append("Diagnostic ");
		result.append(severityToStr(severity));
		if (issueCode != null) {
			result.append(" code=");
			result.append(issueCode);
		}
		result.append(" \"");
		result.append(message);
		result.append("\"");
		if (getSourceEObject() != null) {
			result.append(" at ");
			result.append(EmfFormatter.objPath(getSourceEObject()));
		}
		return result.toString();
	}
	
	public static String severityToStr(int severity) {
		switch (severity) {
			case OK:
				return "OK";
			case INFO:
				return "INFO";
			case WARNING:
				return "WARNING";
			case ERROR:
				return "ERROR";
			case CANCEL:
				return "CANCEL";
			default:
				return Integer.toHexString(severity);
		}
	}
}