com.pi4j.io.gpio.analog.AnalogOutputProvider Maven / Gradle / Ivy

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

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

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

    // ---------------------------------------------------------------------------
    // FRIENDLY HELPER CREATOR STATIC METHODS
    // ---------------------------------------------------------------------------

    /**
     * create.
     *
     * @param address a {@link java.lang.Integer} object.
     * @param  a T object.
     * @return a T object.
     */
    default  T create(Integer address) {
        var builder = AnalogOutputConfigBuilder.newInstance(context());
        builder.address(address);
        return (T)create(builder.build());
    }

    /**
     * create.
     *
     * @param address a {@link java.lang.Integer} object.
     * @param id a {@link java.lang.String} object.
     * @param  a T object.
     * @return a T object.
     */
    default  T create(Integer address, String id) {
        var builder = AnalogOutputConfigBuilder.newInstance(context());
        builder.id(id).address(address).id(id);
        return (T)create(builder.build());
    }

    /**
     * create.
     *
     * @param address a {@link java.lang.Integer} object.
     * @param id a {@link java.lang.String} object.
     * @param name a {@link java.lang.String} object.
     * @param  a T object.
     * @return a T object.
     */
    default  T create(Integer address, String id, String name) {
        var builder = AnalogOutputConfigBuilder.newInstance(context());
        builder.id(id).address(address).id(id).name(name);
        return (T)create(builder.build());
    }

    /**
     * create.
     *
     * @param address a {@link java.lang.Integer} object.
     * @param id a {@link java.lang.String} object.
     * @param name a {@link java.lang.String} object.
     * @param description a {@link java.lang.String} object.
     * @param  a T object.
     * @return a T object.
     */
    default  T create(Integer address, String id, String name, String description) {
        var builder = AnalogOutputConfigBuilder.newInstance(context());
        builder.id(id).address(address).id(id).name(name).description(description);
        return (T)create(builder.build());
    }
}