com.pi4j.provider.ProviderBase Maven / Gradle / Ivy

Go to download
package com.pi4j.provider;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  ProviderBase.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.Config;
import com.pi4j.context.Context;
import com.pi4j.exception.InitializeException;
import com.pi4j.exception.LifecycleException;
import com.pi4j.exception.ShutdownException;
import com.pi4j.extension.ExtensionBase;
import com.pi4j.io.IO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Map;

/**
 * Abstract ProviderBase class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public abstract class ProviderBase
        extends ExtensionBase
        implements Provider {

    protected Logger logger = LoggerFactory.getLogger(this.getClass());
    protected Context context;

    /**
     * Constructor for ProviderBase.
     */
    public ProviderBase(){
        super();
    }

    /**
     * Constructor for ProviderBase.
     *
     * @param id a {@link java.lang.String} object.
     */
    public ProviderBase(String id){
        super(id);
    }

    /**
     * Constructor for ProviderBase.
     *
     * @param id a {@link java.lang.String} object.
     * @param name a {@link java.lang.String} object.
     */
    public ProviderBase(String id, String name){
        super(id, name);
    }

    /** {@inheritDoc} */
    @Override
    public PROVIDER_TYPE initialize(Context context) throws InitializeException {
        this.context = context;
        return (PROVIDER_TYPE)this;
    }

    /** {@inheritDoc} */
    @Override
    public PROVIDER_TYPE shutdown(Context context) throws ShutdownException {

        // TODO :: ABSTRACT PROVIDER IO INSTANCE SHUTDOWN VIA PROXY IMPL

        // perform a shutdown on each digital I/O instance that is tracked in the internal cache
        Map instances = context.registry().allByProvider(this.id(), IO.class);
        instances.forEach((address, instance)->{
            try {
                instance.shutdown(context);
            } catch (LifecycleException e) {
                logger.error(e.getMessage(), e);
            }
        });
        return (PROVIDER_TYPE)this;
    }

    /** {@inheritDoc} */
    @Override
    public Context context(){
        return this.context;
    }
}