KickJava   Java API By Example, From Geeks To Geeks.

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


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.IAdaptable;
14
15 /**
16  * Non-plug-in entry defines an arbitrary non-plug-in data file packaged
17  * as part of a feature. Non-plug-in entries are not interpreted by the
18  * platform (other than being downloaded as part of an install action).
19  * They require a custom install handler to be specified as part of the
20  * feature. Note, that defining a non-plug-in entry does not necessarily
21  * indicate the non-plug-in file is packaged together with any other
22  * feature files. The actual packaging details are determined by the
23  * feature content provider for the feature.
24  * <p>
25  * Clients may implement this interface. However, in most cases clients should
26  * directly instantiate or subclass the provided implementation of this
27  * interface.
28  * </p>
29  * <p>
30  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
31  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
32  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
33  * (repeatedly) as the API evolves.
34  * </p>
35  * @see org.eclipse.update.core.NonPluginEntry
36  * @see org.eclipse.update.core.FeatureContentProvider
37  * @since 2.0
38  */
39 public interface INonPluginEntry extends IPlatformEnvironment, IAdaptable {
40
41     /**
42      * Returns the identifier of this data entry.
43      *
44      * @return data entry identifier
45      * @since 2.0
46      */
47     public String JavaDoc getIdentifier();
48
49     /**
50      * Returns the download size of the entry, if it can be determined.
51      *
52      * @see org.eclipse.update.core.model.ContentEntryModel#UNKNOWN_SIZE
53      * @return download size of the feature in KiloBytes, or an indication
54      * the size could not be determined
55      * @since 2.0
56      */
57     public long getDownloadSize();
58
59     /**
60      * Returns the install size of the feature, if it can be determined.
61      *
62      * @see org.eclipse.update.core.model.ContentEntryModel#UNKNOWN_SIZE
63      * @return install size of the feature in KiloBytes, or an indication
64      * the size could not be determined
65      * @since 2.0
66      */
67     public long getInstallSize();
68 }
69
Popular Tags