KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > core > plugin > IPluginImport


1 /*******************************************************************************
2  * Copyright (c) 2000, 2007 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.core.plugin;
12
13 import org.eclipse.core.runtime.CoreException;
14 /**
15  * Objects that implement this interface represent references
16  * to required plug-ins.
17  */

18 public interface IPluginImport extends IPluginObject, IPluginReference {
19     /**
20      * A name of the property that will be used to notify
21      * about changes in the "reexported" field.
22      */

23     String JavaDoc P_REEXPORTED = "export"; //$NON-NLS-1$
24
/**
25      * A name of the property that will be used to notify
26      * about changes in the "optional" field.
27      */

28     String JavaDoc P_OPTIONAL = "optional"; //$NON-NLS-1$
29
/**
30      * Tests whether the imported plug-in is reexported for
31      * plug-ins that will use this plug-in.
32      *
33      * @return true if the required plug-in libraries are reexported
34      */

35     boolean isReexported();
36     /**
37      * Tests whether this import is optional. Optional imports will
38      * not create an error condition when they cannot be resolved.
39      *
40      * @return true if this import is optional
41      */

42     boolean isOptional();
43     /**
44      * Sets whether the libraries of the required plug-in will
45      * be reexported.
46      * This method will throw a CoreException if the model
47      * is not editable.
48      *
49      * @param value true if reexporting is desired
50      */

51     void setReexported(boolean value) throws CoreException;
52     /**
53      * Sets whether this import is optional. Optional imports will
54      * not create an error condition when they cannot be resolved.
55      *
56      * @param value true if import is optional
57      */

58     void setOptional(boolean value) throws CoreException;
59
60 }
61
Popular Tags