com.pi4j.io.IOBase Maven / Gradle / Ivy

Go to download
package com.pi4j.io;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  IOBase.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.common.Descriptor;
import com.pi4j.common.IdentityBase;
import com.pi4j.context.Context;
import com.pi4j.exception.InitializeException;
import com.pi4j.exception.ShutdownException;
import com.pi4j.provider.Provider;


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

    protected CONFIG_TYPE config;
    protected PROVIDER_TYPE provider;
    private Context context;

    /** {@inheritDoc} */
    @Override
    public PROVIDER_TYPE provider(){
        return this.provider;
    }

    /**
     * Constructor for IOBase.
     *
     * @param provider a PROVIDER_TYPE object.
     * @param config a CONFIG_TYPE object.
     */
    public IOBase(PROVIDER_TYPE provider, CONFIG_TYPE config){
        super();
        this.id = config.id();
        this.name = config.name();
        this.description = config.description();
        this.provider = provider;
        this.config = config;
    }

    /** {@inheritDoc} */
    @Override
    public IO_TYPE name(String name){
        this.name = name;
        return (IO_TYPE)this;
    }

    /** {@inheritDoc} */
    @Override
    public IO_TYPE description(String description){
        this.description = description;
        return (IO_TYPE)this;
    }

    /** {@inheritDoc} */
    @Override
    public CONFIG_TYPE config(){
        return this.config;
    }

    protected Context context() {
        return this.context;
    }

    /** {@inheritDoc} */
    @Override
    public IO_TYPE initialize(Context context) throws InitializeException {
        this.context = context;
        return (IO_TYPE) this;
    }

    /** {@inheritDoc} */
    @Override
    public IO_TYPE shutdown(Context context) throws ShutdownException {
        return (IO_TYPE) this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor describe() {
        return super.describe().category("IO");
    }
}