KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > java > platform > PlatformInstall


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.spi.java.platform;
21
22 import org.openide.WizardDescriptor;
23 import org.openide.filesystems.FileObject;
24
25 /**
26  * Defines an API for registering custom Java platform installer. The Installer
27  * is responsible for recognizing the platform, through its {@link #accept} method,
28  * and for instantiation itself, through the provided wizard iterator.
29  *
30  * @author Svata Dedic, Tomas Zezula
31  */
32 public abstract class PlatformInstall extends GeneralPlatformInstall {
33     /**
34      * XXX Javadoc for this method is completely inadequate. What does it do?
35      * Determines whether the Recognizer recognizes a Java Platform in
36      * the passed folder. The check done by this method should be quick
37      * and should not involve launching the virtual machine. The framework will
38      * call a more detailed check later.
39      * @return TemplateWizard.Iterator instance responsible for instantiating
40      * the platform. The instantiate method of the returned iterator should
41      * return the Set containing the created JavaPlatform.
42      */
43     public abstract WizardDescriptor.InstantiatingIterator createIterator(FileObject baseFolder);
44
45     /**
46      * Checks whether a given folder contains a platform of the supported type.
47      * @param baseFolder folder which may be an installation root of a platform
48      * @return true if the folder is recognized
49      */
50     public abstract boolean accept(FileObject baseFolder);
51
52 }
53
Popular Tags