com.pi4j.io.serial.impl.DefaultSerialConfigBuilder Maven / Gradle / Ivy

Go to download
package com.pi4j.io.serial.impl;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DefaultSerialConfigBuilder.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.impl.IODeviceConfigBuilderBase;
import com.pi4j.io.serial.*;

/**
 * DefaultSerialConfigBuilder class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class DefaultSerialConfigBuilder
        extends IODeviceConfigBuilderBase
        implements SerialConfigBuilder {

    /**
     * PRIVATE CONSTRUCTOR
     */
    protected DefaultSerialConfigBuilder(Context context){
        super(context);
    }

    /**
     * newInstance.
     *
     * @return a {@link com.pi4j.io.serial.SerialConfigBuilder} object.
     */
    public static SerialConfigBuilder newInstance(Context context) {
        return new DefaultSerialConfigBuilder(context);
    }

    /** {@inheritDoc} */
    @Override
    public SerialConfigBuilder baud(Integer rate) {
        this.properties.put(SerialConfig.BAUD_KEY, rate.toString());
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public SerialConfigBuilder dataBits(DataBits bits) {
        this.properties.put(SerialConfig.DATA_BITS_KEY, Integer.toString(bits.value()));
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public SerialConfigBuilder parity(Parity parity) {
        this.properties.put(SerialConfig.PARITY_KEY, parity.name());
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public SerialConfigBuilder stopBits(StopBits bits) {
        this.properties.put(SerialConfig.STOP_BITS_KEY, Integer.toString(bits.value()));
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public SerialConfigBuilder flowControl(FlowControl control) {
        this.properties.put(SerialConfig.FLOW_CONTROL_KEY, control.name());
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public SerialConfig build() {
        SerialConfig config = new DefaultSerialConfig(getResolvedProperties());
        return config;
    }
}