com.pi4j.io.serial.SerialConfig Maven / Gradle / Ivy

Go to download
package com.pi4j.io.serial;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  SerialConfig.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * 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.
 * #L%
 */

import com.pi4j.config.DeviceConfig;
import com.pi4j.io.IOConfig;

/**
 * SerialConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface SerialConfig extends DeviceConfig, IOConfig {
    /** Constant BAUD_KEY="baud" */
    String BAUD_KEY = "baud";
    /** Constant STOP_BITS_KEY="stop-bits" */
    String STOP_BITS_KEY = "stop-bits";
    /** Constant DATA_BITS_KEY="data-bits" */
    String DATA_BITS_KEY = "data-bits";
    /** Constant PARITY_KEY="parity" */
    String PARITY_KEY = "parity";
    /** Constant FLOW_CONTROL_KEY="flow-control" */
    String FLOW_CONTROL_KEY = "flow-control";

    /**
     * baud.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer baud();
    /**
     * getBaud.
     *
     * @return a {@link java.lang.Integer} object.
     */
    default Integer getBaud() {
        return baud();
    }

    /**
     * stopBits.
     *
     * @return a {@link com.pi4j.io.serial.StopBits} object.
     */
    StopBits stopBits();
    /**
     * getStopBits.
     *
     * @return a {@link com.pi4j.io.serial.StopBits} object.
     */
    default StopBits getStopBits() {
        return stopBits();
    }

    /**
     * dataBits.
     *
     * @return a {@link com.pi4j.io.serial.DataBits} object.
     */
    DataBits dataBits();
    /**
     * getDataBits.
     *
     * @return a {@link com.pi4j.io.serial.DataBits} object.
     */
    default DataBits getDataBits() {
        return dataBits();
    }

    /**
     * parity.
     *
     * @return a {@link com.pi4j.io.serial.Parity} object.
     */
    Parity parity();
    /**
     * getParity.
     *
     * @return a {@link com.pi4j.io.serial.Parity} object.
     */
    default Parity getParity() {
        return parity();
    }

    /**
     * flowControl.
     *
     * @return a {@link com.pi4j.io.serial.FlowControl} object.
     */
    FlowControl flowControl();
    /**
     * getFlowControl.
     *
     * @return a {@link com.pi4j.io.serial.FlowControl} object.
     */
    default FlowControl getFlowControl(){
        return flowControl();
    }
}