Interface PsyFormalQueue<T extends PsyObject>

Type Parameters:

T - a type of contained objects.

All Superinterfaces:

Iterable<T>, PsyBounded, PsyClearable, PsyContainer<T>, PsyIterable<T>, PsyLengthy, PsyObject, PsySequential<T>, PsyStreamable<T>

All Known Implementing Classes:

PsyBlockingQueue

@Type("formalqueue")
public interface PsyFormalQueue<T extends PsyObject>
extends PsyBounded, PsyContainer<T>

The representation of formalqueue, an abstraction of a queue of objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_DEQUEUE	Context action of the dequeue operator.
static final ContextAction	PSY_ENQUEUE	Context action of the enqueue operator.
static final ContextAction	PSY_GIVE	Context action of the give operator.
static final ContextAction	PSY_TAKE	Context action of the take operator.

Fields inherited from interface PsyBounded

PSY_CAPACITY, PSY_ISFULL

Fields inherited from interface PsyClearable

PSY_CLEAR

Fields inherited from interface PsyLengthy

PSY_ISEMPTY, PSY_LENGTH

Fields inherited from interface PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TOSTRING, PSY_TOSTRINGBUFFER, PSY_TYPE

Fields inherited from interface PsySequential

PSY_FORALL

Fields inherited from interface PsyStreamable

PSY_STREAM

Method Summary

Modifier and Type	Method	Description
T	psyDequeue()	Removes and returns the head of this queue.
void	psyEnqueue(T o)	Inserts an element into this queue.
void	psyGive(T o)
T	psyTake()

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface PsyBounded

capacity, isFull, psyCapacity, psyIsFull

Methods inherited from interface PsyClearable

psyClear

Methods inherited from interface PsyContainer

psyNewEmpty, toSyntaxStringHelper

Methods inherited from interface PsyIterable

psyStream, psyToArray, psyUnite

Methods inherited from interface PsyLengthy

isEmpty, length, psyIsEmpty, psyLength

Methods inherited from interface PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToString, psyToStringBuffer, psyType, toSyntaxString, typeName

Methods inherited from interface PsyStreamable

psyForAll

Field Details

PSY_DEQUEUE

@OperatorType("dequeue")
static final ContextAction PSY_DEQUEUE

Context action of the dequeue operator.

PSY_ENQUEUE

@OperatorType("enqueue")
static final ContextAction PSY_ENQUEUE

Context action of the enqueue operator.

PSY_GIVE

@OperatorType("give")
static final ContextAction PSY_GIVE

Context action of the give operator.

PSY_TAKE

@OperatorType("take")
static final ContextAction PSY_TAKE

Context action of the take operator.

Method Details

psyDequeue

T psyDequeue()
      throws PsyErrorException

Removes and returns the head of this queue.

Returns:

a head of this queue.

Throws:

PsyErrorException - when this queue is empty.

psyEnqueue

void psyEnqueue(T o)
         throws PsyErrorException

Inserts an element into this queue.

Parameters:

o - the element to enqueue.

Throws:

PsyErrorException - when the element can not be inserted without violation of the capacity restrictions.

psyTake

T psyTake()
   throws PsyErrorException

Throws:

PsyErrorException

psyGive

void psyGive(T o)
      throws PsyErrorException

Throws:

PsyErrorException