com.prosysopc.ua.stack.utils

Class IncubationQueue<T>

java.lang.Object

com.prosysopc.ua.stack.utils.IncubationQueue<T>

Deprecated.

This internal class is no longer used and will be removed in a future update.

@Deprecated
public class IncubationQueue<T>
extends Object

IncubationQueue is ordered queue where objects are added in two phases; (a) as incubating, they are given queuing number, and as (b) hatched they become available to the consumer. Objects become consumable when they are hatch()ed. The order of incubation is maintained. Objects become consumable in the order they were incubate()ed. This class is synchronized and is multi-thread-safe.

Example:

 
 IncubationQueue q = new IncubationQueue();
 q.incubate("a");
 q.incubate("b");
 q.incubate("c");
 q.hatch("b");
 q.removeNextHatchedIfAvailable(); // returns null
 q.hatch("a");
 q.removeNextHatched(); // returns "a"
 q.removeNextHatched(); // returns "b"
 q.removeNextHatchedIfAvailable(); // returns null
 q.hatch("c");
 q.removeNextHatched(); // returns "c"
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	maxWaitTime Deprecated. Maximum wait time in milliseconds for blocking operations, such as getNext() and waitUntilIncubated(Object).

Constructor Summary

Constructors

Constructor and Description
IncubationQueue() Deprecated. Create new Incubation queue that compares with equals()/hashCode
IncubationQueue(boolean identityComparison) Deprecated. Create new Incubation queue

Method Summary

Modifier and Type	Method and Description
void	clear() Deprecated. clear.
boolean	contains(T o) Deprecated. contains.
T	getNext() Deprecated. getNext.
T	getNextHatched() Deprecated. Get next hatched object, blocks if empty or unhatched
T	getNextHatchedIfAvailable() Deprecated. Get next hatched object
boolean	hatch(T o) Deprecated. Hatch incubating object o.
void	incubate(T o) Deprecated. Add object to the queue
boolean	isEmpty() Deprecated. isEmpty.
boolean	isHatched(T o) Deprecated. isHatched.
boolean	isIncubating(T o) Deprecated. isIncubating.
Iterator<T>	iterator() Deprecated. Non-thread safe iterator.
boolean	nextIsHatched() Deprecated. Is next object hatched
T	removeNextHatched() Deprecated. Remove next hatched object.
T	removeNextHatchedIfAvailable() Deprecated. Remove next hatched object if available
T	removeNextHatchedUninterruptibly() Deprecated. Remove next hatched object.
int	size() Deprecated. size.
void	waitUntilIncubated(T o) Deprecated. waitUntilIncubated.

Methods inherited from class java.lang.Object

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

Field Detail

maxWaitTime

public static int maxWaitTime

Deprecated.

Maximum wait time in milliseconds for blocking operations, such as getNext() and waitUntilIncubated(Object). Default 60000 (ms).

Constructor Detail

IncubationQueue

public IncubationQueue()

Deprecated.

Create new Incubation queue that compares with equals()/hashCode

IncubationQueue

public IncubationQueue(boolean identityComparison)

Deprecated.

Create new Incubation queue

Parameters:

identityComparison - if true objects are compared with ==, false compare with equals()/hashCode()

Method Detail

clear

public void clear()

Deprecated.

clear.

contains

public boolean contains(T o)

Deprecated.

contains.

Parameters:

o - a T object.

Returns:

a boolean.

getNext

public T getNext()
          throws InterruptedException

Deprecated.

getNext.

Returns:

a T object.

Throws:

InterruptedException - if any.

getNextHatched

public T getNextHatched()
                 throws InterruptedException

Deprecated.

Get next hatched object, blocks if empty or unhatched

Returns:

next hatched object

Throws:

InterruptedException - if any.

getNextHatchedIfAvailable

public T getNextHatchedIfAvailable()

Deprecated.

Get next hatched object

Returns:

next hatched object or null

hatch

public boolean hatch(T o)
              throws IllegalArgumentException

Deprecated.

Hatch incubating object o. If all objects in the queue before o are hatched, all of them are returned in the order they were added to the queue. If there is an object still incubating before o, an empty list is returned.

Parameters:

o - object not null

Returns:

true if o was incubating

Throws:

IllegalArgumentException - if o was not incubating

incubate

public void incubate(T o)

Deprecated.

Add object to the queue

Parameters:

o - object not null and not in queue

isEmpty

public boolean isEmpty()

Deprecated.

isEmpty.

Returns:

a boolean.

isHatched

public boolean isHatched(T o)

Deprecated.

isHatched.

Parameters:

o - a T object.

Returns:

a boolean.

isIncubating

public boolean isIncubating(T o)

Deprecated.

isIncubating.

Parameters:

o - a T object.

Returns:

a boolean.

iterator

public Iterator<T> iterator()

Deprecated.

Non-thread safe iterator. Removing is not allowed.

Returns:

iterator

nextIsHatched

public boolean nextIsHatched()

Deprecated.

Is next object hatched

Returns:

true if there is an object in queue and it is hatched

removeNextHatched

public T removeNextHatched()
                    throws InterruptedException

Deprecated.

Remove next hatched object. Blocks until next is available.

Returns:

next hatched object

Throws:

InterruptedException - if any.

removeNextHatchedIfAvailable

public T removeNextHatchedIfAvailable()

Deprecated.

Remove next hatched object if available

Returns:

next hatched object or null

removeNextHatchedUninterruptibly

public T removeNextHatchedUninterruptibly()

Deprecated.

Remove next hatched object. Blocks until next is available.

Returns:

next hatched object

size

public int size()

Deprecated.

size.

Returns:

a int.

waitUntilIncubated

public void waitUntilIncubated(T o)
                        throws InterruptedException

Deprecated.

waitUntilIncubated.

Parameters:

o - a T object.

Throws:

InterruptedException - if any.