Progeneric.Ptl.Iterators

Enum IteratorCategory

java.lang.Object

java.lang.Enum<IteratorCategory>

Progeneric.Ptl.Iterators.IteratorCategory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IteratorCategory>

public enum IteratorCategory
extends java.lang.Enum<IteratorCategory>

Defines the iterator category enumeration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BidIter Bidirectional iterator.
FwdIter Forward iterator.
InpIter Input iterator.
OutIter Output iterator.
RanIter Random iterator.

Method Summary

Methods

Modifier and Type	Method and Description
static IteratorCategory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IteratorCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

InpIter

public static final IteratorCategory InpIter

Input iterator.

OutIter

public static final IteratorCategory OutIter

Output iterator.

FwdIter

public static final IteratorCategory FwdIter

Forward iterator.

BidIter

public static final IteratorCategory BidIter

Bidirectional iterator.

RanIter

public static final IteratorCategory RanIter

Random iterator.

Method Detail

values

public static IteratorCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IteratorCategory c : IteratorCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IteratorCategory valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null