com.pi4j.io.serial.SerialBase 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.serial;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  SerialBase.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.io.IOBase;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Abstract SerialBase class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public abstract class SerialBase extends IOBase implements Serial {

    Logger logger = LoggerFactory.getLogger(this.getClass());
    protected boolean isOpen = false;

    /**
     * Constructor for SerialBase.
     *
     * @param provider a {@link com.pi4j.io.serial.SerialProvider} object.
     * @param config a {@link com.pi4j.io.serial.SerialConfig} object.
     */
    public SerialBase(SerialProvider provider, SerialConfig config){
        super(provider, config);
        logger.trace("created instance with config: {}", config);
    }

    /** {@inheritDoc} */
    @Override
    public boolean isOpen() {
        return this.isOpen;
    }

    /** {@inheritDoc} */
    @Override
    public void open() {
        logger.trace("invoked 'open()'");
    }

    /** {@inheritDoc} */
    @Override
    public void close() {
        logger.trace("invoked 'closed()'");
        this.isOpen = false;
    }
}