01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: /*
43: * CustomCLDCPlatformConfigurator.java
44: *
45: */
46: package org.netbeans.spi.mobility.cldcplatform;
47:
48: import java.io.File;
49:
50: /**
51: * CustomCLDCPlatformConfigurator is an SPI for service providing information about some non-standard CLDC platform (SDK, emulator).
52: * This interface has to be implemented and registered in module META-INF/services/org.netbeans.spi.mobility.cldcplatform.CustomCLDCPlatformConfigurator
53: * #position=xx attribute of the registration is important if two different CustomCLDCPlatformConfigurator implementation recognize the same platform.
54: * @author Adam Sotona
55: */
56: public interface CustomCLDCPlatformConfigurator {
57:
58: /**
59: * This method must provide just quick answer if the given folder might be a home for a platform recognized by this configurator.
60: * This method is not intended to perform any deep detection.
61: * The best way is to just check for any unique files inside.
62: * @param platformPath Given platform home directory to query.
63: * @return True if this configurator recognizes the folder as possible known platform home directory.
64: */
65: public boolean isPossiblePlatform(File platformPath);
66:
67: /**
68: * This method is called when the previous for deep detection of the platform.
69: * The method should return full platform descriptor or null.
70: * @param platformPath Given platform home for the detection.
71: * @return CLDCPlatformDescriptor with full information about the platform or null.
72: */
73: public CLDCPlatformDescriptor getPlatform(File platformPath);
74:
75: /**
76: * Optional method helping the automated platforms detection using Windows registry.
77: * If the platform installer stores any keys pointing to the platform installation directory then this method is usefull.
78: * Usual pattern is to store such information somewhere under HKEY_LOCAL_MACHINE/Software/<provider name> or HKEY_CURRENT_USER/Software/<provider name>
79: * @return Part of the provider name that may help to locate registry key with reference to the platform installation (f.ex.: Nokia)
80: */
81: public String getRegistryProviderName();
82:
83: }
|