com.pi4j.io.gpio.digital.DigitalOutputConfig Maven / Gradle / Ivy

Go to download
package com.pi4j.io.gpio.digital;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DigitalOutputConfig.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;

/**
 * DigitalOutputConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface DigitalOutputConfig extends DigitalConfig {
    /** Constant SHUTDOWN_STATE_KEY="shutdown" */
    String SHUTDOWN_STATE_KEY = "shutdown";
    /** Constant INITIAL_STATE_KEY="initial" */
    String INITIAL_STATE_KEY = "initial";

    /**
     * shutdownState.
     *
     * @return a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     */
    DigitalState shutdownState();
    /**
     * shutdownState.
     *
     * @param state a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputConfig} object.
     */
    DigitalOutputConfig shutdownState(DigitalState state);
    /**
     * getShutdownState.
     *
     * @return a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     */
    default DigitalState getShutdownState(){
        return shutdownState();
    }
    /**
     * setShutdownState.
     *
     * @param state a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     */
    default void setShutdownState(DigitalState state){
        this.shutdownState(state);
    }

    /**
     * initialState.
     *
     * @return a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     */
    DigitalState initialState();
    /**
     * getInitialState.
     *
     * @return a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     */
    default DigitalState getInitialState(){
        return initialState();
    }

    /**
     * newBuilder.
     *
     * @param context {@link Context}
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputConfigBuilder} object.
     */
    static DigitalOutputConfigBuilder newBuilder(Context context)  {
        return DigitalOutputConfigBuilder.newInstance(context);
    }
}