org.mule.extension.file.internal

Class FileInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.AutoCloseInputStream

org.mule.extension.file.common.api.stream.AbstractFileInputStream

org.mule.extension.file.internal.FileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class FileInputStream
extends org.mule.extension.file.common.api.stream.AbstractFileInputStream

AbstractFileInputStream implementation used to obtain a file's content based on a Reader.

This stream will automatically close itself once fully consumed but will not fail if AbstractFileInputStream.close() is invoked after that.

This class also contains a PathLock which will be released when the stream is closed. However, this class will never invoke the PathLock.tryLock() method on it, it's the responsibility of whomever is creating this instance to determine if that lock is to be acquired.

Since:

4.0

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
FileInputStream(Path path, org.mule.extension.file.common.api.lock.PathLock lock) Creates a new instance

Method Summary

Methods inherited from class org.mule.extension.file.common.api.stream.AbstractFileInputStream

close, doClose, isLocked

Methods inherited from class org.apache.commons.io.input.AutoCloseInputStream

afterRead, finalize

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInputStream

public FileInputStream(Path path,
                       org.mule.extension.file.common.api.lock.PathLock lock)

Creates a new instance

Parameters:

path -

lock - a PathLock