org.netbeans.spi.java.platform

Class PlatformInstall

java.lang.Object

org.netbeans.spi.java.platform.GeneralPlatformInstall

org.netbeans.spi.java.platform.PlatformInstall

public abstract class PlatformInstall
extends GeneralPlatformInstall

Defines an API for registering custom Java platform installer. The Installer is responsible for recognizing the platform, through its PlatformInstall.accept(org.openide.filesystems.FileObject) method, and for instantiation itself, through the provided wizard iterator. Consult the GeneralPlatformInstall javadoc about the PlatformInstall registration.

Constructor Summary

Constructors

Constructor and Description
PlatformInstall()

Method Summary

Modifier and Type	Method and Description
abstract boolean	accept(FileObject baseFolder) Checks whether a given folder contains a platform of the supported type.
abstract WizardDescriptor.InstantiatingIterator<WizardDescriptor>	createIterator(FileObject baseFolder) Creates a WizardDescriptor.InstantiatingIterator for an accepted folder.

Methods inherited from class org.netbeans.spi.java.platform.GeneralPlatformInstall

getDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformInstall

public PlatformInstall()

Method Detail

createIterator

public abstract WizardDescriptor.InstantiatingIterator<WizardDescriptor> createIterator(FileObject baseFolder)

Creates a WizardDescriptor.InstantiatingIterator for an accepted folder. The platform definition file returned by the instantiate method should be created in the Services/Platforms/org-netbeans-api-java-Platform folder on the system filesystem.

Returns:

TemplateWizard.Iterator instance responsible for instantiating the platform. The instantiate method of the returned iterator should return the Set containing the platform.

accept

public abstract boolean accept(FileObject baseFolder)

Checks whether a given folder contains a platform of the supported type. The check done by this method should be quick and should not involve launching the virtual machine, the expensive check, if needed, should be done in the wizard panel.

Parameters:

baseFolder - folder which may be an installation root of a platform

Returns:

true if the folder is recognized