com.pi4j.extension.Plugin 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.extension;

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

/**
 * Plugin interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface Plugin  {
    /**
     * initialize.
     *
     * @param service a {@link com.pi4j.extension.PluginService} object.
     * @throws InitializeException if error occurs initializing the plugin
     */
    void initialize(PluginService service) throws InitializeException;

    /**
     * shutdown.
     *
     * @param context a {@link com.pi4j.context.Context} object.
     * @throws ShutdownException if an error occurs shutting down the plugin
     */
    default void shutdown(Context context) throws ShutdownException {
        // do nothing 
    }

    /**
     * Returns true if this plugin is a mock plugin, and shouldn't generally be used
     *
     * @return a boolean
     */
    default boolean isMock() {
        return false;
    }
}