jfilesyslib.utils

Class MemoryStream

java.lang.Object

jfilesyslib.utils.MemoryStream

public class MemoryStream
extends java.lang.Object

A file system which may be written to or read from at the same time.
The memory consists of chunks.
It is thread safe.

Author:

Marc Miltenberger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MemoryStream.Chunk Represents a single chunk

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULTCHUNKSIZE

Constructor Summary

Constructors

Constructor and Description
MemoryStream() Creates a new instance of MemoryStream.
MemoryStream(byte[] memory) Creates a new instance of MemoryStream.
MemoryStream(byte[] memory, int chunksize) Creates a new instance of MemoryStream.
MemoryStream(int chunksize) Creates a new instance of MemoryStream.
MemoryStream(java.util.List<MemoryStream.Chunk> chunkList) Creates a new instance of MemoryStream.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the memory stream.
void	flush() Flushes the stream (no effect)
java.util.List<MemoryStream.Chunk>	getChunkList() Returns the used chunk list
int	getLength() Returns the content's length
int	getPosition() Returns the position
int	read(byte[] content) Reads as much as possible into content
void	seek(long offset) Seeks to the specified offset.
void	seek(long offset, boolean stretch) Seeks to the specified offset.
void	setLength(long newLength) Sets the new length
byte[]	toArray() Returns the content as a single byte array
void	write(byte[] input) Writes input to the memory stream.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTCHUNKSIZE

public static final int DEFAULTCHUNKSIZE

See Also:

Constant Field Values

Constructor Detail

MemoryStream

public MemoryStream()

Creates a new instance of MemoryStream.

MemoryStream

public MemoryStream(int chunksize)

Creates a new instance of MemoryStream.

Parameters:

chunksize - the size of each chunk

MemoryStream

public MemoryStream(byte[] memory)
             throws java.io.IOException

Creates a new instance of MemoryStream.

Parameters:

memory - the initial content

Throws:

java.io.IOException

MemoryStream

public MemoryStream(byte[] memory,
            int chunksize)
             throws java.io.IOException

Creates a new instance of MemoryStream.

Parameters:

memory - the initial content

chunksize - the size of each chunk

Throws:

java.io.IOException

MemoryStream

public MemoryStream(java.util.List<MemoryStream.Chunk> chunkList)

Creates a new instance of MemoryStream.

Parameters:

chunkList - the chunk list

Method Detail

flush

public void flush()

Flushes the stream (no effect)

getLength

public int getLength()

Returns the content's length

Returns:

the content's length

getPosition

public int getPosition()

Returns the position

Returns:

the position

setLength

public void setLength(long newLength)
               throws java.io.IOException

Sets the new length

Parameters:

newLength - the new length

Throws:

java.io.IOException

seek

public void seek(long offset)
          throws java.io.IOException

Seeks to the specified offset. If the offset is larger than the content size, the content will be streched.

Parameters:

offset - the offset

Throws:

java.io.IOException

seek

public void seek(long offset,
        boolean stretch)
          throws java.io.IOException

Seeks to the specified offset. If the offset is larger than the content size, the content will be streched iff stretch is true.

Parameters:

offset - the offset

stretch - whether to stretch the content

Throws:

java.io.IOException

write

public void write(byte[] input)
           throws java.io.IOException

Writes input to the memory stream.

Parameters:

input - the input data

Throws:

java.io.IOException

close

public void close()

Closes the memory stream.
It has no effect.

read

public int read(byte[] content)
         throws java.io.IOException

Reads as much as possible into content

Parameters:

content - the output byte array

Returns:

the number of read bytes

Throws:

java.io.IOException

getChunkList

public java.util.List<MemoryStream.Chunk> getChunkList()

Returns the used chunk list

Returns:

the used chunk list

toArray

public byte[] toArray()
               throws java.io.IOException

Returns the content as a single byte array

Returns:

the content as a single byte array

Throws:

java.io.IOException