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

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

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  FlowControl.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%
 */

/**
 * FlowControl class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public enum FlowControl {

    NONE(0),
    HARDWARE(1),
    SOFTWARE(2);

    private int index = 0;

    private FlowControl(int index){
        this.index = index;
    }

    /**
     * Getter for the field index.
     *
     * @return a int.
     */
    public int getIndex(){
        return this.index;
    }

    /**
     * getInstance.
     *
     * @param flow_control a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.serial.FlowControl} object.
     */
    public static FlowControl getInstance(String flow_control) {
        return FlowControl.valueOf(flow_control.toUpperCase());
    }

    /**
     * getInstance.
     *
     * @param control a int.
     * @return a {@link com.pi4j.io.serial.FlowControl} object.
     */
    public static FlowControl getInstance(int control){
        for(FlowControl fc : FlowControl.values()){
            if(fc.getIndex() == control){
                return fc;
            }
        }
        return null;
    }

    /**
     * parse.
     *
     * @param parity a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.serial.FlowControl} object.
     */
    public static FlowControl parse(String parity) {
        if(parity.equalsIgnoreCase("0")) return FlowControl.NONE;
        if(parity.equalsIgnoreCase("1")) return FlowControl.HARDWARE;
        if(parity.equalsIgnoreCase("2")) return FlowControl.SOFTWARE;
        if(parity.toLowerCase().startsWith("n")) return FlowControl.NONE;
        if(parity.toLowerCase().startsWith("h")) return FlowControl.HARDWARE;
        if(parity.toLowerCase().startsWith("s")) return FlowControl.SOFTWARE;
        return FlowControl.NONE;
    }
}