Package org.irods.irods4j.high_level.vfs

Class IRODSCollectionIterator

java.lang.Object

org.irods.irods4j.high_level.vfs.IRODSCollectionIterator

All Implemented Interfaces:

Iterable<CollectionEntry>

public class IRODSCollectionIterator
extends Object
implements Iterable<CollectionEntry>

A class which makes it easy to iterate over the contents of a collection. Instances of this class do not visit subcollections.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IRODSCollectionIterator.CollectionEntryIterator	The class providing the iterator implementation over a collection.
static enum	IRODSCollectionIterator.CollectionOptions	Options which affect the behavior of the iterator.

Constructor Summary

Constructors

Constructor	Description
IRODSCollectionIterator(IRODSApi.RcComm comm, String logicalPath)	Initializes a newly created iterator.
IRODSCollectionIterator(IRODSApi.RcComm comm, String logicalPath, int rowsPerPage)	Initializes a newly created iterator.
IRODSCollectionIterator(IRODSApi.RcComm comm, String logicalPath, int rowsPerPage, IRODSCollectionIterator.CollectionOptions options)	Initializes a newly created iterator.
IRODSCollectionIterator(IRODSApi.RcComm comm, String logicalPath, IRODSCollectionIterator.CollectionOptions options)	Initializes a newly created iterator.

Method Summary

Modifier and Type	Method	Description
int	getRowsPerPage()	Returns the max number of rows a single page may contain.
Iterator<CollectionEntry>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

IRODSCollectionIterator

public IRODSCollectionIterator(IRODSApi.RcComm comm,
 String logicalPath)
                        throws IRODSFilesystemException,
IOException,
IRODSException

Initializes a newly created iterator.

Parameters:

comm - The connection to the iRODS server.

logicalPath - The absolute path to a collection.

Throws:

IRODSException

IOException

IRODSFilesystemException

IllegalArgumentException - If invalid inputs are passed.

Since:

0.1.0

IRODSCollectionIterator

public IRODSCollectionIterator(IRODSApi.RcComm comm,
 String logicalPath,
 int rowsPerPage)
                        throws IRODSFilesystemException,
IOException,
IRODSException

Initializes a newly created iterator.

Parameters:

comm - The connection to the iRODS server.

logicalPath - The absolute path to a collection.

rowsPerPage - The max number of rows to fetch when a new page of data is needed.

Throws:

IRODSException

IOException

IRODSFilesystemException

IllegalArgumentException - If invalid inputs are passed.

Since:

0.1.0

IRODSCollectionIterator

public IRODSCollectionIterator(IRODSApi.RcComm comm,
 String logicalPath,
 IRODSCollectionIterator.CollectionOptions options)
                        throws IRODSFilesystemException,
IOException,
IRODSException

Initializes a newly created iterator.

Parameters:

comm - The connection to the iRODS server.

logicalPath - The absolute path to a collection.

options - Options affecting the behavior of the iterator. Currently unused.

Throws:

IRODSException

IOException

IRODSFilesystemException

Since:

0.1.0

IRODSCollectionIterator

public IRODSCollectionIterator(IRODSApi.RcComm comm,
 String logicalPath,
 int rowsPerPage,
 IRODSCollectionIterator.CollectionOptions options)
                        throws IRODSFilesystemException,
IOException,
IRODSException

Initializes a newly created iterator.

Parameters:

comm - The connection to the iRODS server.

logicalPath - The absolute path to a collection.

rowsPerPage - The max number of rows to fetch when a new page of data is needed.

options - Options affecting the behavior of the iterator. Currently unused.

Throws:

IRODSException

IOException

IRODSFilesystemException

Since:

0.1.0

Method Details

getRowsPerPage

public int getRowsPerPage()

Returns the max number of rows a single page may contain.

Since:

0.1.0

iterator

public Iterator<CollectionEntry> iterator()

Specified by:

iterator in interface Iterable<CollectionEntry>