KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > ifeature > IFeatureModel


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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.pde.internal.core.ifeature;
12
13 import org.eclipse.pde.core.IModel;
14 import org.eclipse.pde.core.IModelChangeProvider;
15 /**
16  * This model type is designed to hold data loaded from
17  * "feature.xml" file of an Eclipse feature.
18  */

19 public interface IFeatureModel extends IModel, IModelChangeProvider {
20 /**
21  * Returns the top-level model object.
22  *
23  * @return top-level model object of the feature model
24  */

25 public IFeature getFeature();
26 /**
27  * Returns the factory that should be used
28  * to create new instances of model objects.
29  *
30  * @return feature model factory
31  */

32 IFeatureModelFactory getFactory();
33 /**
34  * Returns install location of the feature.xml file
35  * in case of external files.
36  *
37  * @return install location for external files,
38  * or <samp>null</samp> for models based on
39  * workspace resources.
40  */

41 public String JavaDoc getInstallLocation();
42 /**
43  * Tests whether this model is enabled.
44  *
45  * @return <samp>true</samp> if the model is enabled
46  */

47 public boolean isEnabled();
48 /**
49  * Enables or disables this model.
50  *
51  * @param enabled the new enable state
52  */

53 public void setEnabled(boolean enabled);
54 }
55
Popular Tags