net.wimpi.modbus.ModbusIOException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jamod Show documentation

jamod is an object oriented implementation of the Modbus protocol, realized 100% in Java. It allows to quickly realize master and slave applications in various transport flavors (IP and serial).

The newest version!

/***
 * Copyright 2002-2010 jamod development team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ***/

package net.wimpi.modbus;

/**
 * Class that implements a ModbusIOException.
 * Instances of this exception are thrown when
 * errors in the I/O occur.
 *
 * @author Dieter Wimberger
 * @version 1.2 (@date@)
 */
public class ModbusIOException
    extends ModbusException {

  private boolean m_EOF = false;

  /**
   * Constructs a new ModbusIOException
   * instance.
   */
  public ModbusIOException() {
  }//constructor

  /**
   * Constructs a new ModbusIOException
   * instance with the given message.
   * 
   * @param message the message describing this
   *        ModbusIOException.
   */
  public ModbusIOException(String message) {
    super(message);
  }//constructor(String)

  /**
   * Constructs a new ModbusIOException
   * instance.
   *
   * @param b true if caused by end of stream, false otherwise.
   */
  public ModbusIOException(boolean b) {
    m_EOF = b;
  }//constructor

  /**
   * Constructs a new ModbusIOException
   * instance with the given message.
   * 

   * @param message the message describing this
   *        ModbusIOException.
   * @param b true if caused by end of stream, false otherwise.
   */
  public ModbusIOException(String message, boolean b) {
    super(message);
    m_EOF = b;
  }//constructor(String)


  /**
   * Tests if this ModbusIOException
   * is caused by an end of the stream.
   * 

   * @return true if stream ended, false otherwise.
   */
  public boolean isEOF() {
    return m_EOF;
  }//isEOF

  /**
   * Sets the flag that determines whether this
   * ModbusIOException was caused by
   * an end of the stream.
   * 
   * @param b true if stream ended, false otherwise.
   */
  public void setEOF(boolean b) {
    m_EOF = b;
  }//setEOF

}//ModbusIOException