001/**
002 * Copyright 2017, Digi International Inc.
003 *
004 * This Source Code Form is subject to the terms of the Mozilla Public
005 * License, v. 2.0. If a copy of the MPL was not distributed with this
006 * file, you can obtain one at http://mozilla.org/MPL/2.0/.
007 *
008 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
009 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
010 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
011 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
012 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
013 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
014 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
015 */
016package com.digi.xbee.api.exceptions;
017
018/**
019 * This exception will be thrown when there is an error parsing an API packet
020 * from the input stream.
021 * 
022 * @see CommunicationException
023 */
024public class InvalidPacketException extends CommunicationException {
025
026        // Constants
027        private static final long serialVersionUID = 1L;
028        private static final String DEFAULT_MESSAGE = "The XBee API packet is not properly formed.";
029
030        /**
031         * Creates a {@code InvalidPacketException} with {@value #DEFAULT_MESSAGE} 
032         * as its error detail message.
033         */
034        public InvalidPacketException() {
035                super(DEFAULT_MESSAGE);
036        }
037        
038        /**
039         * Creates a {@code InvalidPacketException} with the specified message.
040         * 
041         * @param message The associated message.
042         */
043        public InvalidPacketException(String message) {
044                super(message);
045        }
046        
047        /**
048         * Creates an {@code InvalidPacketException} with the specified 
049         * message and cause.
050         * 
051         * @param message The associated message.
052         * @param cause The cause of this exception.
053         * 
054         * @see Throwable
055         */
056        public InvalidPacketException(String message, Throwable cause) {
057                super(message, cause);
058        }
059}