org.omg.dds.sub

Interface Sample.Iterator<IT_DATA>

All Superinterfaces:

AutoCloseable, Closeable, Iterator<Sample<IT_DATA>>, ListIterator<Sample<IT_DATA>>

Enclosing interface:

Sample<TYPE>

public static interface Sample.Iterator<IT_DATA>
extends Closeable, ListIterator<Sample<IT_DATA>>

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Sample<IT_DATA> o)
void	close() This operation indicates to that the application is done accessing the list of Samples obtained by some earlier invocation of DataReader.read() or DataReader.take().
void	remove()
void	set(Sample<IT_DATA> o)

Methods inherited from interface java.util.ListIterator

hasNext, hasPrevious, next, nextIndex, previous, previousIndex

Method Detail

close

void close()
           throws IOException

This operation indicates to that the application is done accessing the list of Samples obtained by some earlier invocation of DataReader.read() or DataReader.take(). The operation allows implementations to "loan" buffers from the DataReader to the application and in this manner provide "zero-copy" access to the data. During the loan, the DataReader will guarantee that the data and sample information are not modified. It is not necessary for an application to return the loans immediately after the read or take calls. However, as these buffers correspond to internal resources inside the DataReader, the application should not retain them indefinitely. The use of the operation is only necessary if the read or take calls "loaned" buffers to the application. The situations in which this occurs are described in the documentation for DataReader.read() and DataReader.take(). However, calling close on a collection that does not have a loan is safe and has no side effects.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

See Also:

DataReader.read(), DataReader.take()

remove

void remove()

Specified by:

remove in interface Iterator<Sample<IT_DATA>>

Specified by:

remove in interface ListIterator<Sample<IT_DATA>>

Throws:

UnsupportedOperationException - always.

set

void set(Sample<IT_DATA> o)

Specified by:

set in interface ListIterator<Sample<IT_DATA>>

Throws:

UnsupportedOperationException - always.

add

void add(Sample<IT_DATA> o)

Specified by:

add in interface ListIterator<Sample<IT_DATA>>

Throws:

UnsupportedOperationException - always.