Package net.haesleinhuepf.clij.coremem.fragmented

Class FragmentedMemory

java.lang.Object

net.haesleinhuepf.clij.coremem.rgc.FreeableBase

net.haesleinhuepf.clij.coremem.fragmented.FragmentedMemory

All Implemented Interfaces:

Iterable<ContiguousMemoryInterface>, FragmentedMemoryInterface, ReadWriteBytesFileChannel, SizedInBytes, Freeable

public class FragmentedMemory
extends FreeableBase
implements FragmentedMemoryInterface

Fragmented memory objects are lists of contiguous memory regions. Overall, the referenced memory is not necessarily (but can be) contiguous.

Author:

royer

Constructor Summary

Constructors

Constructor	Description
FragmentedMemory()	Default constructor, fragmented memory initially empty.

Method Summary

Modifier and Type	Method	Description
OffHeapMemory	add(Buffer pBuffer)	Adds a NIO buffer to this fragmented memory.
void	add(ContiguousMemoryInterface pContiguousMemoryInterface)	Adds a contiguous memory fragment to this fragmented memory
void	free()	Free this object, which means that the underlying ressources are released.
ContiguousMemoryInterface	get(int pIndex)	Returns the contiguous memory at a given index.
int	getNumberOfFragments()	Returns the number of fragments.
long	getSizeInBytes()	Return this memory object's size in bytes.
boolean	isFree()	Returns true if the object has been freed, which usually means that the underlying ressources are not longer available.
Iterator<ContiguousMemoryInterface>	iterator()
OffHeapMemory	makeConsolidatedCopy()	Returns a consolidated contiguous copy of this fragmented memory - this is done by simply concatenating the contiguous memory regions together in the list order.
void	makeConsolidatedCopy(ContiguousMemoryInterface pDestinationMemory)	Consolidates (copies) the contents of this fragmented memory into a given contiguous buffer.
long	readBytesFromFileChannel(long pBufferPositionInBytes, FileChannel pFileChannel, long pFilePositionInBytes, long pLengthInBytes)
long	readBytesFromFileChannel(FileChannel pFileChannel, long pFilePositionInBytes, long pLengthInBytes)	Reads data into this memory object for a certain position of a file channel.
void	remove(ContiguousMemoryInterface pContiguousMemoryInterface)	Removes a counties fragment from this fragmented memory.
static FragmentedMemory	split(ContiguousMemoryInterface pContiguousMemoryInterface, long pNumberOfFragments)	Splits a contiguous memory regions into n pieces of same size (if possible, otherwise the last one is smaller)
static FragmentedMemoryInterface	wrap(ContiguousMemoryInterface... pContiguousMemoryInterfaces)	Wrap a list of contiguous memory regions into a single fragmented memory.
long	writeBytesToFileChannel(long pBufferPositionInBytes, FileChannel pFileChannel, long pFilePositionInBytes, long pLengthInBytes)	Writes data at a given range from this memory object at a given offset of a file channel.
long	writeBytesToFileChannel(FileChannel pFileChannel, long pFilePositionInBytes)	Writes the whole contents of this memory object at a given offset of a file channel.

Methods inherited from class net.haesleinhuepf.clij.coremem.rgc.FreeableBase

complainIfFreed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.haesleinhuepf.clij.coremem.rgc.Freeable

complainIfFreed

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FragmentedMemory

public FragmentedMemory()

Default constructor, fragmented memory initially empty.

Method Detail

split

public static FragmentedMemory split(ContiguousMemoryInterface pContiguousMemoryInterface,
                                     long pNumberOfFragments)

Splits a contiguous memory regions into n pieces of same size (if possible, otherwise the last one is smaller)

Parameters:

pContiguousMemoryInterface - contiguous memory region

pNumberOfFragments - number of fragments

Returns:

fragmented memory

wrap

public static FragmentedMemoryInterface wrap(ContiguousMemoryInterface... pContiguousMemoryInterfaces)

Wrap a list of contiguous memory regions into a single fragmented memory.

Parameters:

pContiguousMemoryInterfaces - array of contiguous memory regions.

Returns:

fragmented memory

get

public ContiguousMemoryInterface get(int pIndex)

Description copied from interface: FragmentedMemoryInterface

Returns the contiguous memory at a given index.

Specified by:

get in interface FragmentedMemoryInterface

Parameters:

pIndex - index

Returns:

contiguous memory

getNumberOfFragments

public int getNumberOfFragments()

Description copied from interface: FragmentedMemoryInterface

Returns the number of fragments.

Specified by:

getNumberOfFragments in interface FragmentedMemoryInterface

Returns:

number of fragments

add

public void add(ContiguousMemoryInterface pContiguousMemoryInterface)

Description copied from interface: FragmentedMemoryInterface

Adds a contiguous memory fragment to this fragmented memory

Specified by:

add in interface FragmentedMemoryInterface

Parameters:

pContiguousMemoryInterface - contiguous fragment

remove

public void remove(ContiguousMemoryInterface pContiguousMemoryInterface)

Description copied from interface: FragmentedMemoryInterface

Removes a counties fragment from this fragmented memory.

Specified by:

remove in interface FragmentedMemoryInterface

Parameters:

pContiguousMemoryInterface - ?

add

public OffHeapMemory add(Buffer pBuffer)

Description copied from interface: FragmentedMemoryInterface

Adds a NIO buffer to this fragmented memory.

Specified by:

add in interface FragmentedMemoryInterface

Parameters:

pBuffer - NIO buffer

Returns:

the actual contiguous memory used internally.

makeConsolidatedCopy

public OffHeapMemory makeConsolidatedCopy()

Description copied from interface: FragmentedMemoryInterface

Returns a consolidated contiguous copy of this fragmented memory - this is done by simply concatenating the contiguous memory regions together in the list order.

Specified by:

makeConsolidatedCopy in interface FragmentedMemoryInterface

Returns:

consolidated memory

makeConsolidatedCopy

public void makeConsolidatedCopy(ContiguousMemoryInterface pDestinationMemory)

Description copied from interface: FragmentedMemoryInterface

Consolidates (copies) the contents of this fragmented memory into a given contiguous buffer.

Specified by:

makeConsolidatedCopy in interface FragmentedMemoryInterface

Parameters:

pDestinationMemory - destination memory

writeBytesToFileChannel

public long writeBytesToFileChannel(FileChannel pFileChannel,
                                    long pFilePositionInBytes)
                             throws IOException

Description copied from interface: ReadWriteBytesFileChannel

Writes the whole contents of this memory object at a given offset of a file channel.

Specified by:

writeBytesToFileChannel in interface ReadWriteBytesFileChannel

Parameters:

pFileChannel - file channel

pFilePositionInBytes - file position

Returns:

file position past the last written byte.

Throws:

IOException - Thrown in case of IO problem.

writeBytesToFileChannel

public long writeBytesToFileChannel(long pBufferPositionInBytes,
                                    FileChannel pFileChannel,
                                    long pFilePositionInBytes,
                                    long pLengthInBytes)
                             throws IOException

Description copied from interface: ReadWriteBytesFileChannel

Writes data at a given range from this memory object at a given offset of a file channel.

Specified by:

writeBytesToFileChannel in interface ReadWriteBytesFileChannel

Parameters:

pBufferPositionInBytes - offset in memory object

pFileChannel - file channel

pFilePositionInBytes - file channel offset

pLengthInBytes - length in bytes

Returns:

file position past the last written byte.

Throws:

IOException - Thrown in case of IO problem.

readBytesFromFileChannel

public long readBytesFromFileChannel(FileChannel pFileChannel,
                                     long pFilePositionInBytes,
                                     long pLengthInBytes)
                              throws IOException

Description copied from interface: ReadWriteBytesFileChannel

Reads data into this memory object for a certain position of a file channel.

Specified by:

readBytesFromFileChannel in interface ReadWriteBytesFileChannel

Parameters:

pFileChannel - file channel

pFilePositionInBytes - offset in file channel

pLengthInBytes - length in bytes

Returns:

File position past the last byte read.

Throws:

IOException - Thrown in case of IO problem.

readBytesFromFileChannel

public long readBytesFromFileChannel(long pBufferPositionInBytes,
                                     FileChannel pFileChannel,
                                     long pFilePositionInBytes,
                                     long pLengthInBytes)
                              throws IOException

Specified by:

readBytesFromFileChannel in interface ReadWriteBytesFileChannel

Parameters:

pBufferPositionInBytes - offset in memory object

pFileChannel - file channel

pFilePositionInBytes - offset in file channel

pLengthInBytes - length in bytes

Returns:

File position past the last byte read.

Throws:

IOException - Thrown in case of IO problem.

getSizeInBytes

public long getSizeInBytes()

Description copied from interface: SizedInBytes

Return this memory object's size in bytes.

Specified by:

getSizeInBytes in interface SizedInBytes

Returns:

size in bytes.

free

public void free()

Description copied from interface: Freeable

Free this object, which means that the underlying ressources are released.

Specified by:

free in interface Freeable

isFree

public boolean isFree()

Description copied from interface: Freeable

Returns true if the object has been freed, which usually means that the underlying ressources are not longer available.

Specified by:

isFree in interface Freeable

Returns:

true if free

iterator

public Iterator<ContiguousMemoryInterface> iterator()

Specified by:

iterator in interface Iterable<ContiguousMemoryInterface>