org.refcodes.serial.SerialUtility Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-serial Show documentation

Artifact providing generic (byte) serialization functionality including a TTY-/COM-Port implementation of the serial framework as well as a (local) loopback port.

The newest version!

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany, distributed
// on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, and licen-
// sed under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.serial;

import java.io.InputStream;

import org.refcodes.io.AvailableInputStream;
import org.refcodes.io.TimeoutInputStream;

/**
 * Functionality to be maintainable and common for the whole of the serial
 * package.
 */
public class SerialUtility {

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	private SerialUtility() {
		throw new IllegalStateException( "Utility class" );
	}

	/**
	 * Hook creating a {@link TimeoutInputStream} compliant {@link InputStream}.
	 * 
	 * @param aInputStream The {@link InputStream} to be decorated with timeout
	 *        functionality.
	 * @param aTimeoutMillis The timeout in milliseconds to apply.
	 * 
	 * @return The according {@link TimeoutInputStream} compliant InputStream,
	 */
	public static TimeoutInputStream createTimeoutInputStream( InputStream aInputStream, long aTimeoutMillis ) {
		return new AvailableInputStream( aInputStream, aTimeoutMillis );
		// return new TimeoutInputStream( aInputStream, aTimeoutMillis );
	}
}