KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > configurator > IPlatformConfigurationFactory


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11 package org.eclipse.update.configurator;
12
13 import java.io.IOException JavaDoc;
14 import java.net.URL JavaDoc;
15
16 /**
17  * Factory for creating platform configurations.
18  * <p>
19  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
20  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
21  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
22  * (repeatedly) as the API evolves.
23  * </p>
24  */

25 public interface IPlatformConfigurationFactory {
26     /**
27      * Returns the current platform configuration.
28      *
29      * @return platform configuration used in current instance of platform
30      */

31     public IPlatformConfiguration getCurrentPlatformConfiguration();
32     /**
33      * Returns a platform configuration object, optionally initialized with previously saved
34      * configuration information.
35      *
36      * @param url location of previously save configuration information. If <code>null</code>
37      * is specified, an empty configuration object is returned
38      * @return platform configuration used in current instance of platform
39      */

40     public IPlatformConfiguration getPlatformConfiguration(URL JavaDoc url) throws IOException JavaDoc;
41 }
42
Popular Tags