com.digi.xbee.api.exceptions.InvalidPacketException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xbee-java-library Show documentation

There is a newer version: 1.3.2

/**
 * Copyright 2017, Digi International Inc.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
package com.digi.xbee.api.exceptions;

/**
 * This exception will be thrown when there is an error parsing an API packet
 * from the input stream.
 * 
 * @see CommunicationException
 */
public class InvalidPacketException extends CommunicationException {

	// Constants
	private static final long serialVersionUID = 1L;
	private static final String DEFAULT_MESSAGE = "The XBee API packet is not properly formed.";

	/**
	 * Creates a {@code InvalidPacketException} with {@value #DEFAULT_MESSAGE} 
	 * as its error detail message.
	 */
	public InvalidPacketException() {
		super(DEFAULT_MESSAGE);
	}
	
	/**
	 * Creates a {@code InvalidPacketException} with the specified message.
	 * 
	 * @param message The associated message.
	 */
	public InvalidPacketException(String message) {
		super(message);
	}
	
	/**
	 * Creates an {@code InvalidPacketException} with the specified 
	 * message and cause.
	 * 
	 * @param message The associated message.
	 * @param cause The cause of this exception.
	 * 
	 * @see Throwable
	 */
	public InvalidPacketException(String message, Throwable cause) {
		super(message, cause);
	}
}