ix.internal.util

Class SingleContainer<T>

java.lang.Object

ix.internal.util.SingleContainer<T>

Type Parameters:

T - the contained element type

public class SingleContainer<T>
extends java.lang.Object

Helper class that stores a single element. The caller may add a new element only when the container is empty and the caller may take the contained element if there is one. Use the isEmpty() to check for the status The add and take methods might throw IllegalStateException, which should indicate a library bug. Typically used by the Interactive methods to help them conform with the Iterable contract, e.g., hasNext() is idempotent, but next() might be called without hasNext() to be called at all. The container is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
SingleContainer()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T value) Add a new value.
boolean	isEmpty()
T	take()

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleContainer

public SingleContainer()

Method Detail

add

public void add(T value)

Add a new value. Might throw an IllegalStateException when the container already has a value.

Parameters:

value - the new value

take

public T take()

Returns:

the content or throws an IllegalStateException when the container is empty.

isEmpty

public boolean isEmpty()

Returns:

true if there is nothing contained