com.pi4j.io.gpio.analog.AnalogBase 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      :  AnalogBase.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.context.Context;
import com.pi4j.event.EventDelegate;
import com.pi4j.event.EventManager;
import com.pi4j.io.binding.AnalogBinding;
import com.pi4j.io.binding.Bindable;
import com.pi4j.io.binding.BindingDelegate;
import com.pi4j.io.binding.BindingManager;
import com.pi4j.io.gpio.GpioBase;

/**
 * Abstract AnalogBase class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public abstract class AnalogBase,
        CONFIG_TYPE extends AnalogConfig,
        PROVIDER_TYPE extends AnalogProvider>
        extends GpioBase
        implements Analog,
        Bindable {

    // internal listeners collection
    protected final EventManager valueChangeEventManager;

    // internal bindings collection
    protected BindingManager bindings;

    /**
     * Constructor for AnalogBase.
     *
     * @param provider a PROVIDER_TYPE object.
     * @param config a CONFIG_TYPE object.
     */
    public AnalogBase(PROVIDER_TYPE provider, CONFIG_TYPE config){

        super(provider, config);

        // create an event manager for analog value change events
        valueChangeEventManager  = new EventManager(this,
            (EventDelegate)
                    (listener, event) -> listener.onAnalogValueChange(event));


        // create a binding manager for digital state change events
        bindings = new BindingManager(this,
            (BindingDelegate)
                (binding, event) -> binding.process(event));
    }

    /** {@inheritDoc} */
    @Override
    public ANALOG_TYPE addListener(AnalogValueChangeListener... listener) {
        valueChangeEventManager.add(listener);
        return (ANALOG_TYPE) this;
    }

    /** {@inheritDoc} */
    @Override
    public ANALOG_TYPE removeListener(AnalogValueChangeListener... listener) {
        valueChangeEventManager.add(listener);
        return (ANALOG_TYPE) this;
    }

    /** {@inheritDoc} */
    @Override
    public ANALOG_TYPE bind(AnalogBinding... binding) {
        return bindings.bind(binding);
    }

    /** {@inheritDoc} */
    @Override
    public ANALOG_TYPE unbind(AnalogBinding ... binding) {
        return bindings.unbind(binding);
    }

    /**
     * Dispatch AnalogInputEvent on analog input changes
     *
     * @param event AnalogInputEvent
     */
    protected void dispatch(AnalogValueChangeEvent event){
        valueChangeEventManager.dispatch(event);
        bindings.process(event);
    }

    /** {@inheritDoc} */
    @Override
    public ANALOG_TYPE shutdown(Context context){
        // remove all listeners
        valueChangeEventManager.clear();

        // remove all bindings
        bindings.clear();

        // return this instance
        return (ANALOG_TYPE) this;
    }

}