001package com.pi4j.io.serial;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  SerialFactory.java  
009 * 
010 * This file is part of the Pi4J project. More information about 
011 * this project can be found here:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2013 Pi4J
015 * %%
016 * Licensed under the Apache License, Version 2.0 (the "License");
017 * you may not use this file except in compliance with the License.
018 * You may obtain a copy of the License at
019 * 
020 *      http://www.apache.org/licenses/LICENSE-2.0
021 * 
022 * Unless required by applicable law or agreed to in writing, software
023 * distributed under the License is distributed on an "AS IS" BASIS,
024 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
025 * See the License for the specific language governing permissions and
026 * limitations under the License.
027 * #L%
028 */
029
030
031import com.pi4j.io.serial.impl.SerialImpl;
032
033/**
034 * <p> This factory class provide a static method to create new 'Serial' instances. </p>
035 * 
036 * <p>
037 * Before using the Pi4J library, you need to ensure that the Java VM in configured with access to
038 * the following system libraries:
039 * <ul>
040 * <li>pi4j</li>
041 * <li>wiringPi</li>
042 * </ul>
043 * <blockquote> This library depends on the wiringPi native system library.</br> (developed by
044 * Gordon Henderson @ <a href="https://projects.drogon.net/">https://projects.drogon.net/</a>)
045 * </blockquote>
046 * </p>
047 * 
048 * @see #Serial
049 * @see #SerialDataEvent
050 * @see #SerialDataListener
051 * 
052 * @see <a href="http://www.pi4j.com/">http://www.pi4j.com/</a>
053 * @author Robert Savage (<a
054 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
055 */
056public class SerialFactory {
057
058    // private constructor 
059    private SerialFactory() {
060        // forbid object construction 
061    }
062    
063    /**
064     * Create New Serial instance
065     * 
066     * @return Return a new Serial implementation instance.
067     */
068    public static Serial createInstance() {
069        return new SerialImpl();
070    }
071}