com.pi4j.io.gpio.digital.DigitalOutputBuilder 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.io.gpio.digital;

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

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

    /**
     * id.
     *
     * @param id a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder id(String id);
    /**
     * name.
     *
     * @param name a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder name(String name);
    /**
     * description.
     *
     * @param description a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder description(String description);
    /**
     * address.
     *
     * @param address a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder address(Integer address);
    /**
     * shutdown.
     *
     * @param state a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder shutdown(DigitalState state);
    /**
     * initial.
     *
     * @param state a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder initial(DigitalState state);

    /**
     * platform.
     *
     * @param platformId a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder platform(String platformId);
    /**
     * platform.
     *
     * @param platformClass a {@link java.lang.Class} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder platform(Class platformClass);
    /**
     * provider.
     *
     * @param providerId a {@link java.lang.String} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder provider(String providerId);
    /**
     * provider.
     *
     * @param providerClass a {@link java.lang.Class} object.
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutputBuilder} object.
     */
    DigitalOutputBuilder provider(Class providerClass);

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

    /**
     * build.
     *
     * @return a {@link com.pi4j.io.gpio.digital.DigitalOutput} object.
     */
    DigitalOutput build();
}