Interface WizardDescriptor.InstantiatingIterator<Data>

Type Parameters:

Data - in practice this should be WizardDescriptor

All Superinterfaces:

WizardDescriptor.Iterator<Data>

All Known Subinterfaces:

WizardDescriptor.AsynchronousInstantiatingIterator<Data>, WizardDescriptor.BackgroundInstantiatingIterator<Data>, WizardDescriptor.ProgressInstantiatingIterator<Data>

Enclosing class:

WizardDescriptor

public static interface WizardDescriptor.InstantiatingIterator<Data>
extends WizardDescriptor.Iterator<Data>

Iterator for a wizard that needs to somehow instantiate new objects. (This interface can replace TemplateWizard.Iterator in a template's declaration.)

Since:

org.openide/1 4.33

Method Summary

Modifier and Type	Method	Description
void	initialize(WizardDescriptor wizard)	Initializes this iterator, called from WizardDescriptor's constructor.
Set	instantiate()	Returns set of instantiated objects.
void	uninitialize(WizardDescriptor wizard)	Uninitializes this iterator, called when the wizard is being closed, no matter what closing option invoked.

Methods inherited from interface org.openide.WizardDescriptor.Iterator

addChangeListener, current, hasNext, hasPrevious, name, nextPanel, previousPanel, removeChangeListener

Method Details

instantiate

Set instantiate()
         throws IOException

Returns set of instantiated objects. If instantiation fails then wizard remains open to enable correct values.

Returns:

a set of objects created (the exact type is at the discretion of the caller)

Throws:

IOException

initialize

void initialize(WizardDescriptor wizard)

Initializes this iterator, called from WizardDescriptor's constructor.

Parameters:

wizard - wizard's descriptor

uninitialize

void uninitialize(WizardDescriptor wizard)

Uninitializes this iterator, called when the wizard is being closed, no matter what closing option invoked.

Parameters:

wizard - wizard's descriptor