/**
 * Copyright (c) 2003-2004 Craig Setera
 * All Rights Reserved.
 * Licensed under the Eclipse Public License - v 1.0
 * For more information see http://www.eclipse.org/legal/epl-v10.html
 */
package eclipseme.preverifier.results;


/**
 * The description of an error that occurred during preverification.
 * <p />
 * Copyright (c) 2003-2004 Craig Setera<br>
 * All Rights Reserved.<br>
 * Licensed under the Eclipse Public License - v 1.0<p/>
 * <br>
 * $Revision: 1.1 $
 * <br>
 * $Date: 2005/09/25 23:53:31 $
 * <br>
 * @author Craig Setera
 */
public class PreverificationError {
	// The error information
	private PreverificationErrorType errorType;
	private PreverificationErrorLocation errorLocation;
	private String detail;
	
	/**
	 * Construct a new error.
	 * 
	 * @param type
	 * @param location
	 * @param detailMessage
	 */
	public PreverificationError(
		PreverificationErrorType type, 
		PreverificationErrorLocation location, 
		String detailMessage) 
	{
		super();

		this.detail = detailMessage;
		this.errorLocation = location;
		this.errorType = type;
	}

	/**
	 * Returns the detailed message concerning this error or <code>null</code>
	 * if no detail message has been specified.
	 * 
	 * @return Returns the detail.
	 */
	public String getDetail() {
		return detail;
	}

	/**
	 * Returns the location where the error occurred.
	 * 
	 * @return Returns the error location.
	 */
	public PreverificationErrorLocation getLocation() {
		return errorLocation;
	}

	/**
	 * Returns the type of the error.
	 * 
	 * @return Returns the error type.
	 */
	public PreverificationErrorType getType() {
		return errorType;
	}
}