com.sun.management.oss
Interface ManagedEntityKeyResultIterator

All Superinterfaces:
java.io.Serializable

public interface ManagedEntityKeyResultIterator
extends java.io.Serializable

Base interface for application specific <ManagedEntity>KeyResultIterator.

Because some JVT operations could potentially return large amounts of Key Results, the iterator design pattern is used for returning the results.

The behavior of the Iterator is the same as that defined for the ManagedEntityValueIterator interface.

An application specific <ManagedEntity>KeyResultIterator interface must comply with the following template:

 public interface <ManagedEntity>KeyResultIterator extends ManagedEntityKeyResultIterator
 {
     public <ManagedEntity>KeyResult[]
     getNext<ManagedEntity>KeyResult( int howMany );
 }
 


Method Summary
 ManagedEntityKeyResult[] getNext(int howMany)
          Retrieve the next available results.
 void remove()
          Deallocate resources associated with this iterator.
 

Method Detail

getNext

public ManagedEntityKeyResult[] getNext(int howMany)
Retrieve the next available results.

Parameters:
howMany - maximum number of results to return.
Returns:
an array of ManagedEntityKeyResults with a size of at most howMany. When no more results are available, an empty array is returned.

remove

public void remove()
            throws RemoveException
Deallocate resources associated with this iterator.

This should be called when the client is finished iterating through the collection.

Throws:
RemoveException