com.pi4j.io.gpio.analog.Analog 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.gpio.analog;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  Analog.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.io.binding.AnalogBinding;
import com.pi4j.io.binding.Bindable;
import com.pi4j.io.gpio.Gpio;

/**
 * Analog interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface Analog,
                CONFIG_TYPE extends AnalogConfig,
                PROVIDER_TYPE extends AnalogProvider>
        extends Gpio,
                Bindable
{
    /**
     * value.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer value();

    /**
     * addListener.
     *
     * @param listener a {@link AnalogValueChangeListener} object.
     * @return a ANALOG_TYPE object.
     */
    ANALOG_TYPE addListener(AnalogValueChangeListener... listener);
    /**
     * removeListener.
     *
     * @param listener a {@link AnalogValueChangeListener} object.
     * @return a ANALOG_TYPE object.
     */
    ANALOG_TYPE removeListener(AnalogValueChangeListener... listener);

    /**
     * equals.
     *
     * @param value a {@link java.lang.Number} object.
     * @return a boolean.
     */
    default boolean equals(Number value) {
        return this.value().intValue() == value.intValue();
    }
    /**
     * getValue.
     *
     * @return a {@link java.lang.Number} object.
     */
    default Number getValue() { return value(); };
}