com.madara.containers

Class Queue

java.lang.Object

com.madara.MadaraJNI

com.madara.containers.Queue

public class Queue
extends MadaraJNI

A facade for a dynamically typed vector within a knowledge base.

Constructor Summary

Constructors

Constructor and Description
Queue() Default constructor
Queue(Queue input) Copy constructor

Method Summary

Modifier and Type	Method and Description
long	count() Returns the number of records currently in the queue
KnowledgeRecord	dequeue(boolean waitForRecord) Attempts to dequeue a record
boolean	enqueue(double value) Attempts to enqueue a double
boolean	enqueue(KnowledgeRecord record) Attempts to enqueue a record
boolean	enqueue(long value) Attempts to enqueue a long
boolean	enqueue(java.lang.String value) Attempts to enqueue a string
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
static Queue	fromPointer(long cptr) Creates a java object instance from a C/C++ pointer
static Queue	fromPointer(long cptr, boolean shouldManage) Creates a java object instance from a C/C++ pointer
java.lang.String	getName() Gets the name of the variable
KnowledgeRecord	inspect(int position) Inspects the record at the specified position
void	resize(long length) Resizes the vector
void	setName(KnowledgeBase kb, java.lang.String name) Sets the name and knowledge base being referred to
void	setName(Variables vars, java.lang.String name) Sets the name and knowledge base being referred to
void	setSettings(UpdateSettings settings) Sets the settings for updating variables in the Knowledge Base
long	size() Returns the maximum size of the queue

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Queue

public Queue()

Default constructor

Queue

public Queue(Queue input)

Copy constructor

Parameters:

input - instance to copy

Method Detail

fromPointer

public static Queue fromPointer(long cptr)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

Returns:

a new java instance of the underlying pointer

fromPointer

public static Queue fromPointer(long cptr,
                                boolean shouldManage)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

shouldManage - if true, manage the pointer

Returns:

a new java instance of the underlying pointer

inspect

public KnowledgeRecord inspect(int position)

Inspects the record at the specified position

Parameters:

position - position in the queue to inspect

Returns:

the record at the position (uncreated record if position is inaccessible)

dequeue

public KnowledgeRecord dequeue(boolean waitForRecord)

Attempts to dequeue a record

Parameters:

waitForRecord - if true, block on a record being added to queue

Returns:

next record in the queue. An uncreated record if empty and waitForRecord is false.

getName

public java.lang.String getName()

Gets the name of the variable

Returns:

name of the variable within the context

resize

public void resize(long length)

Resizes the vector

Parameters:

length - new number of elements of the vector

enqueue

public boolean enqueue(KnowledgeRecord record)

Attempts to enqueue a record

Parameters:

record - the new record to place on the queue

Returns:

true if the queue now contains the record. False is returned if there was not enough room in the queue.

enqueue

public boolean enqueue(double value)

Attempts to enqueue a double

Parameters:

value - the new value to place on the queue

Returns:

true if the queue now contains the record. False is returned if there was not enough room in the queue.

enqueue

public boolean enqueue(long value)

Attempts to enqueue a long

Parameters:

value - the new value to place on the queue

Returns:

true if the queue now contains the record. False is returned if there was not enough room in the queue.

enqueue

public boolean enqueue(java.lang.String value)

Attempts to enqueue a string

Parameters:

value - the new value to place on the queue

Returns:

true if the queue now contains the record. False is returned if there was not enough room in the queue.

setName

public void setName(KnowledgeBase kb,
                    java.lang.String name)

Sets the name and knowledge base being referred to

Parameters:

kb - the knowledge base that contains the name

name - the variable name

setName

public void setName(Variables vars,
                    java.lang.String name)

Sets the name and knowledge base being referred to

Parameters:

vars - the variables facade that contains the name

name - the variable name

setSettings

public void setSettings(UpdateSettings settings)

Sets the settings for updating variables in the Knowledge Base

Parameters:

settings - the settings to use for updating the Knowledge Base

size

public long size()

Returns the maximum size of the queue

Returns:

the maximum number of records in the queue

count

public long count()

Returns the number of records currently in the queue

Returns:

the number of elements in the queue

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance gets garbage collected

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - necessary for override but unused