KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > internal > core > ISiteContentConsumer


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.internal.core;
12
13  
14 import org.eclipse.core.runtime.*;
15 import org.eclipse.update.core.*;
16  
17  /**
18   * A site content consumer manages the storage or archives, plugins and
19   * feature inside an <code> ISite</code>
20   */
21  
22 public interface ISiteContentConsumer {
23
24     /**
25      * Stores a content reference into the SiteContentConsumer
26      * @param contentReference the content reference to store
27      * @param monitor the progress monitor
28      * @throws CoreException if an error occurs storing the content reference
29      * @since 2.0
30      */
31     public void store(ContentReference contentReference, IProgressMonitor monitor) throws CoreException;
32
33     /**
34      * opens a Non plugin Entry for storage
35      * @return the new FeatureContentConsumer for this <code>INonPluginEntry</code>
36      * @throws CoreException if the opens is done on a FeatureContentConsumer parent other than an IFeature.
37      * @since 2.0
38      */
39     public IContentConsumer open(INonPluginEntry nonPluginEntry) throws CoreException;
40
41     /**
42      * opens a Non plugin Entry for storage
43      * @return the new FeatureContentConsumer for this <code>IPluginEntry</code>
44      * @throws CoreException if the opens is done on a FeatureContentConsumer parent other than an IFeature.
45      * @since 2.0
46      */
47     public IContentConsumer open(IPluginEntry pluginEntry) throws CoreException;
48     
49     /**
50      * closes the opened SiteContentConsumer
51      * @throws CoreException
52      * @since 2.0
53      */
54     public IFeatureReference close() throws CoreException ;
55     
56
57     /**
58      * aborts the opened SiteContentConsumer
59      * @throws CoreException
60      * @since 2.0
61      */
62     public void abort() throws CoreException;
63     
64 }
65
66
67
Popular Tags