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 - 2013 Pi4J
015 * %%
016 * Licensed under the Apache License, Version 2.0 (the "License");
017 * you may not use this file except in compliance with the License.
018 * You may obtain a copy of the License at
019 * 
020 *      http://www.apache.org/licenses/LICENSE-2.0
021 * 
022 * Unless required by applicable law or agreed to in writing, software
023 * distributed under the License is distributed on an "AS IS" BASIS,
024 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
025 * See the License for the specific language governing permissions and
026 * limitations under the License.
027 * #L%
028 */
029
030
031/**
032 * <p> This class represents Exception that might occur in Serial interface.</p>
033 * 
034 * <p>
035 * Before using the Pi4J library, you need to ensure that the Java VM in configured with access to
036 * the following system libraries:
037 * <ul>
038 * <li>pi4j</li>
039 * <li>wiringPi</li>
040 * </ul>
041 * <blockquote> This library depends on the wiringPi native system library.</br> (developed by
042 * Gordon Henderson @ <a href="https://projects.drogon.net/">https://projects.drogon.net/</a>)
043 * </blockquote>
044 * </p>
045 * 
046 * @see #com.pi4j.io.serial.Serial
047 * 
048 * @see <a href="http://www.pi4j.com/">http://www.pi4j.com/</a>
049 * @author Jakub Derda (<a
050 *         href="http://www.ardeo.pl">http://www.ardeo.pl</a>)
051 */
052public class SerialPortException extends RuntimeException {
053        
054        /**
055         * Default serial version ID
056         */
057        private static final long serialVersionUID = 1L;
058
059        /**
060         * Default no argument constructor.
061         */
062        public SerialPortException() {
063                super();
064        }
065        
066        /**
067         * Constructor with description.
068         * 
069         * @param message Description of error that occured.
070         */
071        public SerialPortException(String message) {
072                super(message);
073        }
074        
075        
076        /**
077         * Constructor with cause.
078         * 
079         * @param cause Cause of SerialException.
080         */
081        public SerialPortException(Throwable cause) {
082                super(cause);
083        }
084
085}