KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > core > IPluginEntry


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.update.core;
12
13 import org.eclipse.core.runtime.*;
14
15 /**
16  * Plug-in entry defines a packaging reference from a feature to a plug-in.
17  * It indicates that the referenced plug-in is to be considered as
18  * part of the feature. Note, that this does not necessarily indicate
19  * that the plug-in files are packaged together with any other
20  * feature files. The actual packaging details are determined by the
21  * feature content provider for the feature.
22  * <p>
23  * Clients may implement this interface. However, in most cases clients should
24  * directly instantiate or subclass the provided implementation of this
25  * interface.
26  * </p>
27  * <p>
28  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
29  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
30  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
31  * (repeatedly) as the API evolves.
32  * </p>
33  * @see org.eclipse.update.core.PluginEntry
34  * @see org.eclipse.update.core.FeatureContentProvider
35  * @since 2.0
36  */
37 public interface IPluginEntry extends IPlatformEnvironment,IAdaptable {
38
39     /**
40      * Returns the identifier of this plugin entry
41      *
42      * @return plugin entry identifier
43      * @since 2.0
44      */
45     public VersionedIdentifier getVersionedIdentifier();
46
47     /**
48      * Returns an indication whethyer this entry represents a fragment.
49      *
50      * @return <code>true</code> if the entry represents a plug-in fragment,
51      * <code>false</code> if the entry represents a plug-in
52      * @since 2.0
53      */
54     public boolean isFragment();
55
56     /**
57      * Returns the download size of the entry, if it can be determined.
58      *
59      * @see org.eclipse.update.core.model.ContentEntryModel#UNKNOWN_SIZE
60      * @return download size of the feature in KiloBytes, or an indication
61      * the size could not be determined
62      * @since 2.0
63      */
64     public long getDownloadSize();
65
66     /**
67      * Returns the install size of the feature, if it can be determined.
68      *
69      * @see org.eclipse.update.core.model.ContentEntryModel#UNKNOWN_SIZE
70      * @return install size of the feature in KiloBytes, or an indication
71      * the size could not be determined
72      * @since 2.0
73      */
74     public long getInstallSize();
75
76     /**
77      * Sets the identifier of this plugin entry.
78      * This is typically performed as part of the plug-in entry creation
79      * operation. Once set, the identifier should not be reset.
80      *
81      * @param identifier plugin entry identifier
82      * @since 2.0
83      */
84     public void setVersionedIdentifier(VersionedIdentifier identifier);
85
86 }
87
Popular Tags