br.unicamp.cst.core.entities

Class MemoryBuffer

java.lang.Object

br.unicamp.cst.core.entities.MemoryBuffer

public class MemoryBuffer
extends java.lang.Object

MemoryBuffer is a generic holder for memory objects. It may be used to produce sensory buffers, action buffers or other very short term memory structures.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.concurrent.locks.Lock	lock Safe lock for multithread access

Constructor Summary

Constructors

Constructor and Description
MemoryBuffer(int maxCapacity, RawMemory rawMemory) Creates a MemoryBuffer.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all memory objects from this buffer.
java.util.List<MemoryObject>	get() Returns the original list of memory objects in this buffer.
java.util.ArrayList<MemoryObject>	getAll() Returns a copy of the list of memory objects in this buffer.
MemoryObject	getMostRecent() Gets the most recent Memory Object of this type.
MemoryObject	getOldest() Gets the oldest MemoryObject in this list.
boolean	impendingAccess(Codelet accessing) Safe access through reentrant locks.
MemoryObject	pop() Pops the first memory object that went into this list.
void	printStatus() Prints the status of the Buffer.
void	put(MemoryObject content) Adds one memory object.
void	putList(java.util.List<MemoryObject> contents) Adds a list of memory objects.
boolean	remove(MemoryObject mo) Removes this memory object from this buffer and eliminates it from raw memory.
int	size() Gets the size of the list of Memory objects inside Buffer.

Methods inherited from class java.lang.Object

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

Field Detail

lock

public volatile java.util.concurrent.locks.Lock lock

Safe lock for multithread access

Constructor Detail

MemoryBuffer

public MemoryBuffer(int maxCapacity,
                    RawMemory rawMemory)

Creates a MemoryBuffer.

Parameters:

maxCapacity - maximum number of elements this buffer holds at a given time.

rawMemory - singleton instance of the system's raw memory.

Method Detail

impendingAccess

public boolean impendingAccess(Codelet accessing)

Safe access through reentrant locks.

Parameters:

accessing - the accessing Codelet

Returns:

true if it is impeding access

putList

public void putList(java.util.List<MemoryObject> contents)

Adds a list of memory objects.

Parameters:

contents - list of Memory Objects to be added

put

public void put(MemoryObject content)

Adds one memory object.

Parameters:

content - one memory object to be added.

get

public java.util.List<MemoryObject> get()

Returns the original list of memory objects in this buffer.

Returns:

the list of Memory objects inside Buffer.

getAll

public java.util.ArrayList<MemoryObject> getAll()

Returns a copy of the list of memory objects in this buffer.

Returns:

the list of Memory objects inside Buffer.

pop

public MemoryObject pop()

Pops the first memory object that went into this list.

Returns:

the first memory object that went into this list.

size

public int size()

Gets the size of the list of Memory objects inside Buffer.

Returns:

size of the list of Memory objects inside Buffer.

getMostRecent

public MemoryObject getMostRecent()

Gets the most recent Memory Object of this type.

Returns:

the most recent Memory Object of this type.

getOldest

public MemoryObject getOldest()

Gets the oldest MemoryObject in this list.

Returns:

the oldest MemoryObject in this list.

remove

public boolean remove(MemoryObject mo)

Removes this memory object from this buffer and eliminates it from raw memory.

Parameters:

mo - memory object to be removed.

Returns:

result of of the removal process.

clear

public void clear()

Clears all memory objects from this buffer.

printStatus

public void printStatus()

Prints the status of the Buffer.