001package com.pi4j.io.serial;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  SerialPortException.java  
009 * 
010 * This file is part of the Pi4J project. More information about 
011 * this project can be found here:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2015 Pi4J
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Lesser General Public License as
018 * published by the Free Software Foundation, either version 3 of the
019 * License, or (at your option) any later version.
020 * 
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Lesser Public License for more details.
025 * 
026 * You should have received a copy of the GNU General Lesser Public
027 * License along with this program.  If not, see
028 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
029 * #L%
030 */
031
032
033/**
034 * <p> This class represents Exception that might occur in Serial interface.</p>
035 * 
036 * <p>
037 * Before using the Pi4J library, you need to ensure that the Java VM in configured with access to
038 * the following system libraries:
039 * <ul>
040 * <li>pi4j</li>
041 * <li>wiringPi</li>
042 * </ul>
043 * <blockquote> This library depends on the wiringPi native system library.</br> (developed by
044 * Gordon Henderson @ <a href="http://wiringpi.com/">http://wiringpi.com/</a>)
045 * </blockquote>
046 * </p>
047 * 
048 * @see com.pi4j.io.serial.Serial
049 * 
050 * @see <a href="http://www.pi4j.com/">http://www.pi4j.com/</a>
051 * @author Jakub Derda (<a
052 *         href="http://www.ardeo.pl">http://www.ardeo.pl</a>)
053 */
054@SuppressWarnings("unused")
055public class SerialPortException extends RuntimeException {
056        
057        /**
058         * Default serial version ID
059         */
060        private static final long serialVersionUID = 1L;
061
062        /**
063         * Default no argument constructor.
064         */
065
066        public SerialPortException() {
067                super();
068        }
069        
070        /**
071         * Constructor with description.
072         * 
073         * @param message Description of error that occured.
074         */
075    public SerialPortException(String message) {
076                super(message);
077        }
078        
079        
080        /**
081         * Constructor with cause.
082         * 
083         * @param cause Cause of SerialException.
084         */
085    public SerialPortException(Throwable cause) {
086                super(cause);
087        }
088}