org.ikasan.connector.basefiletransfer.outbound.command.util

Class FileHandle

java.lang.Object

org.ikasan.connector.basefiletransfer.outbound.command.util.FileHandle

public class FileHandle
extends Object

Simple handle class for providing lightweight access to files. Refers to file content via an InputStream rather than ever needing to refer to the entire content at once Written with the intention for use within functionality that unzips files over FileTransfer protocols whereby we do not want to hold the entire file itself in memory at any given time, rather a handle to an IO stream

Author:

Ikasan Development Team

Constructor Summary

Constructors

Constructor and Description
FileHandle(String path, ByteArrayInputStream byteArrayInputStream) Constructor
FileHandle(String path, InputStream inputStream, boolean isDirectory) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getContentAsInputStream() Returns the content by way of an InputStream Note that as with all InputStreams, once read, there is no way to rewind.
String	getPath() Returns the path of the file as a String
boolean	isDirectory() Accessor for isDirectory flag
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileHandle

public FileHandle(String path,
          InputStream inputStream,
          boolean isDirectory)

Constructor

Parameters:

path -

inputStream -

isDirectory -

FileHandle

public FileHandle(String path,
          ByteArrayInputStream byteArrayInputStream)

Constructor

Parameters:

path -

byteArrayInputStream -

Method Detail

getPath

public String getPath()

Returns the path of the file as a String

Returns:

String

getContentAsInputStream

public InputStream getContentAsInputStream()

Returns the content by way of an InputStream Note that as with all InputStreams, once read, there is no way to rewind. A new instance of the handle would be required.

Returns:

InputStream

isDirectory

public boolean isDirectory()

Accessor for isDirectory flag

Returns:

isDirectory

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()