com.pi4j.provider.impl.RuntimeProviders 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.provider.impl;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  RuntimeProviders.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.exception.InitializeException;
import com.pi4j.exception.ShutdownException;
import com.pi4j.provider.Provider;
import com.pi4j.provider.Providers;

import java.util.Collection;

/**
 * 
 * This class provides static methods to configure the Pi4J library's default
 * platform.  Pi4J supports the following platforms:  RaspberryPi, BananaPi, BananaPro, Odroid.
 * 
 *
 * @see http://www.pi4j.com/
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface RuntimeProviders extends Providers {
    /**
     * shutdown.
     *
     * @return a {@link com.pi4j.provider.impl.RuntimeProviders} object.
     * @throws com.pi4j.exception.ShutdownException if any.
     */
    RuntimeProviders shutdown() throws ShutdownException;
    /**
     * initialize.
     *
     * @param providers a {@link java.util.Collection} object.
     * @return a {@link com.pi4j.provider.impl.RuntimeProviders} object.
     * @throws com.pi4j.exception.InitializeException if any.
     */
    RuntimeProviders initialize(Collection providers) throws InitializeException;
}