com.google.common.collect.testing
Enum IteratorFeature

java.lang.Object
  java.lang.Enum<IteratorFeature>
      com.google.common.collect.testing.IteratorFeature

All Implemented Interfaces:

Serializable, Comparable<IteratorFeature>

public enum IteratorFeature
extends Enum<IteratorFeature>

A method supported by implementations of the Iterator or ListIterator interface.

This enum is GWT compatible.

Author:

Chris Povirk

Enum Constant Summary

SUPPORTS_ADD
Support for ListIterator.add(Object); ignored for plain Iterator implementations.

SUPPORTS_REMOVE
Support for Iterator.remove().

SUPPORTS_SET
Support for ListIterator.set(Object); ignored for plain Iterator implementations.

Field Summary

static Set<IteratorFeature>	MODIFIABLE A set containing all of the optional features of the Iterator and ListIterator interfaces.
static Set<IteratorFeature>	UNMODIFIABLE A set containing none of the optional features of the Iterator or ListIterator interfaces.

Method Summary

static IteratorFeature	valueOf(String name) Returns the enum constant of this type with the specified name.
static IteratorFeature[]	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

SUPPORTS_REMOVE

public static final IteratorFeature SUPPORTS_REMOVE

Support for Iterator.remove().

SUPPORTS_ADD

public static final IteratorFeature SUPPORTS_ADD

Support for ListIterator.add(Object); ignored for plain Iterator implementations.

SUPPORTS_SET

public static final IteratorFeature SUPPORTS_SET

Support for ListIterator.set(Object); ignored for plain Iterator implementations.

Field Detail

UNMODIFIABLE

public static final Set<IteratorFeature> UNMODIFIABLE

A set containing none of the optional features of the Iterator or ListIterator interfaces.

MODIFIABLE

public static final Set<IteratorFeature> MODIFIABLE

A set containing all of the optional features of the Iterator and ListIterator interfaces.

Method Detail

values

public static IteratorFeature[] 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 (IteratorFeature c : IteratorFeature.values())
    System.out.println(c);

Returns:

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

valueOf

public static IteratorFeature valueOf(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:

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

NullPointerException - if the argument is null