jenkins.slaves.iterators.api

Class NodeIterator<N extends hudson.model.Node>

java.lang.Object

jenkins.slaves.iterators.api.NodeIterator<N>

All Implemented Interfaces:

hudson.ExtensionPoint, Iterator<N>

public abstract class NodeIterator<N extends hudson.model.Node>
extends Object
implements Iterator<N>, hudson.ExtensionPoint

A class that iterates through all the Nodes in the system, even nodes which are not attached to the main Jenkins object. If you are holding onto nodes that are not attached to the main Jenkins object then you need to have an Extension which extends this class and can iterate through your Nodes.

Author:

Stephen Connolly

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
NodeIterator()

Method Summary

Methods

Modifier and Type	Method and Description
static NodeIterator<hudson.model.Node>	iterator() Returns a new iterator of all the Nodes in the system.
static <N extends hudson.model.Node> NodeIterator<N>	iterator(Class<N> nodeClass) Returns a new iterator of all the Nodes in the system.
static Iterable<hudson.model.Node>	nodes() Adapter to allow easy use from Java 5+ for loops.
static <N extends hudson.model.Node> Iterable<N>	nodes(Class<N> nodeClass) Adapter to allow easy use from Java 5+ for loops.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Constructor Detail

NodeIterator

public NodeIterator()

Method Detail

iterator

public static NodeIterator<hudson.model.Node> iterator()

Returns a new iterator of all the Nodes in the system.

Returns:

a new iterator of all the Nodes in the system.

nodes

public static Iterable<hudson.model.Node> nodes()

Adapter to allow easy use from Java 5+ for loops.

Returns:

an Iterable.

iterator

public static <N extends hudson.model.Node> NodeIterator<N> iterator(Class<N> nodeClass)

Returns a new iterator of all the Nodes in the system.

Returns:

a new iterator of all the Nodes in the system.

nodes

public static <N extends hudson.model.Node> Iterable<N> nodes(Class<N> nodeClass)

Adapter to allow easy use from Java 5+ for loops.

Returns:

an Iterable.