com.embeddedunveiled.serial.SerialComException Maven / Gradle / Ivy

Go to download
/*
 * Author : Rishi Gupta
 * 
 * This file is part of 'serial communication manager' library.
 * Copyright (C) <2014-2016>  
 *
 * This 'serial communication manager' is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * The 'serial communication manager' is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 
 * A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with 'serial communication manager'.  If not, see .
 */

package com.embeddedunveiled.serial;

import java.io.IOException;

/** 
 * Limit the scope of exceptions in context of serial port communication only.
 * 
 * @author Rishi Gupta
 */
public final class SerialComException extends IOException {

	private static final long serialVersionUID = -6849706871605796050L;
	private String exceptionMsg;

	/**
	 * Constructs and allocate a new SerialComException object with the specified detail message.
	 * 
	 * @param exceptionMsg message describing reason for exception.
	 */
	public SerialComException(String exceptionMsg) {
		super(exceptionMsg);
		this.exceptionMsg = exceptionMsg;
	}

	/** 
	 * Get the specific type of exception. 
	 * 
	 * @return exceptionMsg reason for exception.
	 */
	public String getExceptionMsg() {
		return exceptionMsg;
	}
}