org.snmp4j.util
Interface TreeListener

All Superinterfaces:

java.util.EventListener

public interface TreeListener
extends java.util.EventListener

The TreeListener interface is implemented by objects listening for tree events.

Since:

1.8

Version:

1.10

Author:

Frank Fock

See Also:

TreeUtils

Method Summary

void	finished(TreeEvent event) Indicates in a series of tree events that no more events will follow.
boolean	isFinished() Indicates whether the tree walk is complete or not.
boolean	next(TreeEvent event) Consumes the next table event, which is typically the next row in a table retrieval operation.

Method Detail

next

boolean next(TreeEvent event)

Consumes the next table event, which is typically the next row in a table retrieval operation.

Parameters:

event - a TableEvent instance.

Returns:

true if this listener wants to receive more events, otherwise return false. For example, a TreeListener can return false to stop tree retrieval.

finished

void finished(TreeEvent event)

Indicates in a series of tree events that no more events will follow.

Parameters:

event - a TreeEvent instance that will either indicate an error (RetrievalEvent.isError() returns true) or success of the tree retrieval operation.

isFinished

boolean isFinished()

Indicates whether the tree walk is complete or not.

Returns:

true if it is complete, false otherwise.

Since:

1.10