com.bonzaiengine.io

Class Stream

java.lang.Object

com.bonzaiengine.io.Stream

public final class Stream
extends java.lang.Object

InputStream abstraction to read from different location and kind of data as described and supported by Protocols singleton.

See Also:

Protocols

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LINE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Stream(java.io.InputStream is, java.lang.String name)
Stream(java.lang.String path)
Stream(java.lang.String folder, java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
void	addStreamCallback(IStreamCallback streamCallback)
static java.lang.String	appendsSeparator(java.lang.String path) Appends a file separator at the end of the path.
java.net.URL	buildURL() Create an URL object from a path.
Stream	clone()
void	close() Close the InputStream opened
static void	copy(java.io.File src, java.io.File dst)
static void	copy(java.io.InputStream in, java.io.OutputStream out) Copy the InputStream to the OutputStream.
java.io.File	copyTo(java.io.File fileOfDir, boolean forceFileName)
void	copyTo(java.io.OutputStream os)
void	copyTo(Stream stream)
boolean	equals(java.lang.Object obj)
boolean	exists()
Stream	flattenRelativePath(char pathSeparator) Flatten relative path '..'
java.lang.String	getExpectedName()
java.lang.String	getExtension()
java.lang.String	getInputStreamName() Valid after openStream is called
long	getInputStreamPosition() Valid after openStream is called
long	getInputStreamSize() Valid after openStream is called
long	getInputStreamTimeStamp()
java.lang.String	getLocation()
java.lang.String	getName()
java.lang.String	getNameWithoutExtension()
java.lang.String	getPath()
Stream	getRealStream()
java.io.InputStream	getStream()
int	hashCode()
static boolean	isTrackStreamPosition()
java.io.InputStream	open() Open the stream, using the protocols defined in Protocols.
java.io.InputStream	open(boolean headerOnly) Open the stream, using the protocols defined in Protocols.
java.io.InputStream	open(boolean headerOnly, boolean trackPosition) Open the stream, using the protocols defined in Protocols.
java.io.OutputStream	openOut() Open the stream for writing.
byte[]	readFully() Read the contents of the InputStream into a byte array
Stream	relativize(Stream root)
void	removeCacheStreamCallback()
static java.lang.String	removeFirstSeparator(java.lang.String path) Remove the file separator at the end of the path.
static java.lang.String	removeLastSeparator(java.lang.String path) Remove the file separator at the end of the path.
void	removeStreamCallback(IStreamCallback streamCallback)
static void	setCacheStreamCallback(IStreamCallback cacheStreamCallback) Default callback used for cache system.
static void	setTrackStreamPosition(boolean enable)
static java.lang.String	streamToString(Stream s)
java.lang.String	toString()
Stream	trimExtension()
Stream	withExtension(java.lang.String ext)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

LINE_SEPARATOR

public static final java.lang.String LINE_SEPARATOR

Constructor Detail

Stream

public Stream(java.io.InputStream is,
              java.lang.String name)

Stream

public Stream(java.lang.String path)

Stream

public Stream(java.lang.String folder,
              java.lang.String filename)

Method Detail

isTrackStreamPosition

public static final boolean isTrackStreamPosition()

setTrackStreamPosition

public static final void setTrackStreamPosition(boolean enable)

Parameters:

enable - enable stream position tracking. Default value is false.

setCacheStreamCallback

public static final void setCacheStreamCallback(IStreamCallback cacheStreamCallback)

Default callback used for cache system.

clone

public final Stream clone()

Overrides:

clone in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

addStreamCallback

public final void addStreamCallback(IStreamCallback streamCallback)

removeStreamCallback

public final void removeStreamCallback(IStreamCallback streamCallback)

removeCacheStreamCallback

public final void removeCacheStreamCallback()

getRealStream

public final Stream getRealStream()

open

public final java.io.InputStream open()
                               throws java.io.IOException

Open the stream, using the protocols defined in Protocols.

Returns:

the InputStream opened, or throws an IOException

Throws:

java.io.IOException

open

public final java.io.InputStream open(boolean headerOnly)
                               throws java.io.IOException

Open the stream, using the protocols defined in Protocols.

Parameters:

headerOnly - false stream opening for reading, and have size, timestamp, ... informations.
true to indicate to open to obtains ONLY size, timestamp, ... informations BUT reading will be impossible.

Returns:

the InputStream opened, or throws an IOException

Throws:

java.io.IOException

open

public final java.io.InputStream open(boolean headerOnly,
                                      boolean trackPosition)
                               throws java.io.IOException

Open the stream, using the protocols defined in Protocols.

Parameters:

headerOnly - false stream opening for reading, and have size, timestamp, ... informations. true to indicate to open to obtains ONLY size, timestamp, ... informations BUT reading will be impossible.

trackPosition - enable stream position track for this Stream, getInputStreamPosition() will return the actual stream position in a thread safe way.

Returns:

the InputStream opened, or throws an IOException

Throws:

java.io.IOException

openOut

public final java.io.OutputStream openOut()
                                   throws java.io.IOException

Open the stream for writing.

The returned OutputStream must be close externally.

Warning: close() will not closed the OutputStream returned.

Returns:

the OutputStream opened

Throws:

java.io.IOException

buildURL

public final java.net.URL buildURL()
                            throws java.io.IOException

Create an URL object from a path.
The path can be encoded using on of those protocols: protocols: file, http, ftp, https, jar.

Throws:

java.io.IOException - when an URL can't be created

getInputStreamSize

public final long getInputStreamSize()

Valid after openStream is called

Returns:

the size in bytes of the InputStream. -1 if unknown

Throws:

java.lang.IllegalStateException - if stream is not opened

See Also:

open()

getInputStreamPosition

public final long getInputStreamPosition()

Valid after openStream is called

Returns:

the position in the stream.
returns -1 if stream is closed or stream position tracking is not enabled with Stream#setTrackStreamPosition(boolean).

Throws:

java.lang.IllegalStateException - if stream is not opened

See Also:

open(), setTrackStreamPosition(boolean), isTrackStreamPosition()

getInputStreamName

public final java.lang.String getInputStreamName()

Valid after openStream is called

Returns:

the size in bytes of the InputStream. -1 if unknown

Throws:

java.lang.IllegalStateException - if stream is not opened

See Also:

open()

getInputStreamTimeStamp

public final long getInputStreamTimeStamp()

Throws:

java.lang.IllegalStateException - if stream is not opened

getStream

public final java.io.InputStream getStream()

close

public final void close()

Close the InputStream opened

See Also:

open(), open(boolean), open(boolean, boolean)

exists

public final boolean exists()

Returns:

true if this Stream exists and can be opened

copyTo

public final java.io.File copyTo(java.io.File fileOfDir,
                                 boolean forceFileName)
                          throws java.io.FileNotFoundException,
                                 java.io.IOException

Parameters:

fileOfDir - destination file or folder

forceFileName - use the name of the specified file

Returns:

the File written to

Throws:

java.io.FileNotFoundException

java.io.IOException

copyTo

public final void copyTo(java.io.OutputStream os)
                  throws java.io.IOException

Throws:

java.io.IOException

copyTo

public final void copyTo(Stream stream)
                  throws java.io.IOException

Throws:

java.io.IOException

readFully

public final byte[] readFully()
                       throws java.io.IOException

Read the contents of the InputStream into a byte array

Throws:

java.io.IOException

getName

public final java.lang.String getName()

Returns:

the name component of the path of this Stream

getNameWithoutExtension

public final java.lang.String getNameWithoutExtension()

Returns:

the name component of the path of this Stream, extension removed

getExtension

public final java.lang.String getExtension()

Returns:

the extension of the path of this Stream

getLocation

public final java.lang.String getLocation()

Returns:

the path of this Stream without the name

getPath

public final java.lang.String getPath()

Returns:

the path of this Stream

getExpectedName

public final java.lang.String getExpectedName()

withExtension

public final Stream withExtension(java.lang.String ext)

Parameters:

ext - new extension

Returns:

a new Stream object with the specified extension

trimExtension

public final Stream trimExtension()

Returns:

a new Stream object with the extension removed, or this if no extension found

relativize

public final Stream relativize(Stream root)

flattenRelativePath

public final Stream flattenRelativePath(char pathSeparator)

Flatten relative path '..'
This Stream is supposed to have / separator

Returns:

the new Stream with relative path flatten'ed, or this Stream

copy

public static void copy(java.io.InputStream in,
                        java.io.OutputStream out)
                 throws java.io.IOException

Copy the InputStream to the OutputStream. Streams are not closed

Throws:

java.io.IOException

copy

public static void copy(java.io.File src,
                        java.io.File dst)
                 throws java.io.FileNotFoundException,
                        java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException

streamToString

public static final java.lang.String streamToString(Stream s)
                                             throws java.io.IOException

Throws:

java.io.IOException

appendsSeparator

public static java.lang.String appendsSeparator(java.lang.String path)

Appends a file separator at the end of the path.
If a separator is already present, the path is returned.

removeLastSeparator

public static java.lang.String removeLastSeparator(java.lang.String path)

Remove the file separator at the end of the path.
If no file separator, the path is returned.

removeFirstSeparator

public static java.lang.String removeFirstSeparator(java.lang.String path)

Remove the file separator at the end of the path.
If no file separator, the path is returned.