edu.mit.jmwe.util

Class StreamAdapter

java.lang.Object

java.io.InputStream

edu.mit.jmwe.util.StreamAdapter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class StreamAdapter
extends java.io.InputStream

An adapter that makes a ByteBuffer look like an InputStream.

Since:

jMWE 1.0.0

Version:

$Id: StreamAdapter.java 356 2015-11-25 22:36:46Z markaf $

Author:

M.A. Finlayson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_PROTOCOL The string that indicates the file protocol.
static java.lang.String	UTF8 The string that indicates the UTF8 character encoding.

Constructor Summary

Constructors

Constructor and Description
StreamAdapter(java.nio.ByteBuffer buffer) Creates a new instance of this class that wraps the specified buffer as an InputStream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
static java.io.InputStream	make(java.io.File file) Returns an input stream on the specified file that is backed by a mapped byte buffer, making it much faster than a normal FileInputStream.
static java.io.InputStream	make(java.net.URL url) Returns an input stream for the specified URL.
void	mark(int readlimit)
boolean	markSupported()
int	read()
void	reset()
static java.io.File	toFile(java.net.URL url) Transforms the specified URL into a File object, if in fact the URL points to a file.
static java.net.URL	toURL(java.io.File file) Transforms a file into a URL

Methods inherited from class java.io.InputStream

read, read, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_PROTOCOL

public static final java.lang.String FILE_PROTOCOL

The string that indicates the file protocol.

Since:

jMWE 1.0.0

See Also:

Constant Field Values

UTF8

public static final java.lang.String UTF8

The string that indicates the UTF8 character encoding.

Since:

jMWE 1.0.0

See Also:

Constant Field Values

Constructor Detail

StreamAdapter

public StreamAdapter(java.nio.ByteBuffer buffer)

Creates a new instance of this class that wraps the specified buffer as an InputStream.

Parameters:

buffer - the buffer to be wrapped; may not be null

Throws:

java.lang.NullPointerException - if the specified buffer is null

Since:

jMWE 1.0.0

Method Detail

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.InputStream

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

toFile

public static java.io.File toFile(java.net.URL url)

Transforms the specified URL into a File object, if in fact the URL points to a file. That is, if the URL uses the file:// protocol and is in UTF8 encoding. If the transformation cannot be done, this method returns null.

Parameters:

url - the url to be converted to a file, may not be null

Returns:

the file corresponding to the url, or null if the url does not correspond to a file.

Throws:

java.lang.NullPointerException - if the specified URL is null

Since:

jMWE 1.0.0

toURL

public static java.net.URL toURL(java.io.File file)

Transforms a file into a URL

Parameters:

file - the file to be transformed

Returns:

a URL representing the file

Throws:

java.lang.NullPointerException - if the specified file is null

Since:

jMWE 1.0.0

make

public static java.io.InputStream make(java.net.URL url)
                                throws java.io.IOException

Returns an input stream for the specified URL. This implementation produces a mapped byte-buffer wrapped as a stream if the specified URL points to a local file system resource.

Parameters:

url - the url to make into an input stream

Returns:

an input stream that reads from the specified url

Throws:

java.lang.NullPointerException - if the specified URL is null

java.io.IOException - if there is an IO exception when creating the stream

Since:

jMWE 1.0.0

make

public static java.io.InputStream make(java.io.File file)
                                throws java.io.IOException

Returns an input stream on the specified file that is backed by a mapped byte buffer, making it much faster than a normal FileInputStream.

Parameters:

file - the file on which to open the stream

Returns:

the mapped-byte-buffer-backed input stream for reading the file

Throws:

java.io.IOException - if there was a io error accessing the file

Since:

jMWE 1.0.0