com.pi4j.io.spi.SpiBus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
The newest version!
package com.pi4j.io.spi;

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

/**
 * SpiBus class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public enum SpiBus {
    BUS_0(0), BUS_1(1), BUS_2(2), BUS_3(3), BUS_4(4), BUS_5(5), BUS_6(6);

    private final int bus;

    private SpiBus(int bus) {
        this.bus = bus;
    }

    /**
     * Getter for the field bus.
     *
     * @return a int.
     */
    public int getBus() {
        return bus;
    }

    /**
     * getByNumber.
     *
     * @param busNumber a short.
     * @return a {@link SpiBus} object.
     */
    public static SpiBus getByNumber(short busNumber){
        return getByNumber((int)busNumber);
    }

    /**
     * getByNumber.
     *
     * @param busNumber a int.
     * @return a {@link SpiBus} object.
     */
    public static SpiBus getByNumber(int busNumber){
        for(var item : SpiBus.values()){
            if(item.getBus() == busNumber){
                return item;
            }
        }
        return null;
    }

    /**
     * parse.
     *
     * @param bus a {@link String} object.
     * @return a {@link SpiBus} object.
     */
    public static SpiBus parse(String bus) {
        if(bus.equalsIgnoreCase("0")) return SpiBus.BUS_0;
        if(bus.equalsIgnoreCase("1")) return SpiBus.BUS_1;
        if(bus.equalsIgnoreCase("2")) return SpiBus.BUS_2;
        if(bus.equalsIgnoreCase("3")) return SpiBus.BUS_3;
        if(bus.equalsIgnoreCase("4")) return SpiBus.BUS_4;
        if(bus.equalsIgnoreCase("5")) return SpiBus.BUS_5;
        if(bus.equalsIgnoreCase("6")) return SpiBus.BUS_6;
        return Spi.DEFAULT_BUS;
    }
}