com.pi4j.context.ContextConfig 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.context;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  ContextConfig.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.platform.Platform;
import com.pi4j.provider.Provider;

import java.util.Collection;
import java.util.Map;

/**
 * ContextConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface ContextConfig {

    // **************************************************
    // PLATFORMS
    // **************************************************
    /**
     * platforms.
     *
     * @return a {@link java.util.Collection} object.
     */
    Collection platforms();
    /**
     * getPlatforms.
     *
     * @return a {@link java.util.Collection} object.
     */
    default Collection getPlatforms(){
        return platforms();
    }
    /**
     * autoDetectMockPlugins.
     *
     * @return a boolean.
     */
    boolean autoDetectMockPlugins();
    /**
     * autoDetectPlatforms.
     *
     * @return a boolean.
     */
    boolean autoDetectPlatforms();
    /**
     * getAutoDetectPlatforms.
     *
     * @return a boolean.
     */
    default boolean getAutoDetectPlatforms() { return autoDetectPlatforms(); };
    /**
     * isAutoDetectPlatforms.
     *
     * @return a boolean.
     */
    default boolean isAutoDetectPlatforms() { return autoDetectPlatforms(); };
    /**
     * autoInject.
     *
     * @return a boolean.
     */
    boolean autoInject();
    /**
     * enableShutdownHook.
     *
     * @return a boolean.
     */
    boolean enableShutdownHook();
    /**
     * getAutoInject.
     *
     * @return a boolean.
     */
    default boolean getAutoInject() { return autoInject(); };
    /**
     * isAutoInject.
     *
     * @return a boolean.
     */
    default boolean isAutoInject() { return autoInject(); };
    /**
     * defaultPlatform.
     *
     * @return a {@link java.lang.String} object.
     */
    String defaultPlatform();
    /**
     * getDefaultPlatform.
     *
     * @return a {@link java.lang.String} object.
     */
    default String getDefaultPlatform(){
        return defaultPlatform();
    }
    /**
     * hasDefaultPlatform.
     *
     * @return a boolean.
     */
    default boolean hasDefaultPlatform(){ return getDefaultPlatform() != null;};

    // **************************************************
    // PROVIDERS
    // **************************************************
    /**
     * providers.
     *
     * @return a {@link java.util.Collection} object.
     */
    Collection providers();
    /**
     * getProviders.
     *
     * @return a {@link java.util.Collection} object.
     */
    default Collection getProviders(){
        return providers();
    }
    /**
     * autoDetectProviders.
     *
     * @return a boolean.
     */
    boolean autoDetectProviders();
    /**
     * getAutoDetectProviders.
     *
     * @return a boolean.
     */
    default boolean getAutoDetectProviders() { return autoDetectProviders(); };
    /**
     * isAutoDetectProviders.
     *
     * @return a boolean.
     */
    default boolean isAutoDetectProviders() { return autoDetectProviders(); };

    // **************************************************
    // PROPERTIES
    // **************************************************
    /**
     * properties.
     *
     * @return a {@link java.util.Map} object.
     */
    Map properties();
}