KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > configuration > ISessionDelta


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.configuration;
12
13 import java.util.Date JavaDoc;
14
15 import org.eclipse.core.runtime.*;
16 import org.eclipse.update.core.*;
17
18 /**
19  * Installation Change.
20  * Represents the changes the reconciler found.
21  * <p>
22  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
23  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
24  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
25  * (repeatedly) as the API evolves.
26  * </p>
27  * @since 2.0
28  * @deprecated Do not use this interface
29  */
30 public interface ISessionDelta extends IAdaptable {
31
32     /**
33      * Indicates a processing type to enable the features
34      *
35      * @since 2.0
36      * <p>
37      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
38      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
39      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
40      * (repeatedly) as the API evolves.
41      * </p>
42      */
43     public int ENABLE = 1;
44
45     /**
46      * Indicates a processing type to disable the features
47      *
48      * @since 2.0
49      * <p>
50      * <b>Note:</b> This field is part of an interim API that is still under development and expected to
51      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
52      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
53      * (repeatedly) as the API evolves.
54      * </p>
55      */
56     public int DISABLE = 2;
57
58     /**
59      * Returns the list of Features found during reconciliation
60      *
61      * @return an array of feature references, or an empty array
62      * @since 2.0
63      * <p>
64      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
65      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
66      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
67      * (repeatedly) as the API evolves.
68      * </p>
69      */
70     public IFeatureReference[] getFeatureReferences();
71
72     /**
73      * Returns the date the reconciliation occured
74      *
75      * @return the date of the reconciliation
76      * @since 2.0
77      * <p>
78      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
79      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
80      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
81      * (repeatedly) as the API evolves.
82      * </p>
83      */
84     public Date JavaDoc getDate();
85
86     /**
87      * Returns the type of the processing type
88      * that will affect all the associated features.
89      *
90      * @return the processing type
91      * @see ISessionDelta#ENABLE
92      * @see ISessionDelta#DISABLE
93      * @since 2.0
94      * <p>
95      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
96      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
97      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
98      * (repeatedly) as the API evolves.
99      * </p>
100      */
101     public int getType();
102
103     /**
104      * Process all the feature references of the
105      * Session Delta.
106      * Removes the Session Delta from the file system after processing it.
107      *
108      * @param progressMonitor the progress monitor
109      * @throws CoreException if an error occurs.
110      * @since 2.0
111      * <p>
112      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
113      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
114      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
115      * (repeatedly) as the API evolves.
116      * </p>
117      */
118     public void process(IProgressMonitor progressMonitor) throws CoreException;
119
120     /**
121      * Process the selected feature references of the Session Delta.
122      * Removes the Session Delta from the file system after processing it.
123      *
124      * @param selected list of selected feature references to be processed
125      * @param monitor the progress monitor
126      * @throws CoreException if an error occurs.
127      * @since 2.0
128      * <p>
129      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
130      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
131      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
132      * (repeatedly) as the API evolves.
133      * </p>
134      */
135     public void process(IFeatureReference [] selected, IProgressMonitor monitor) throws CoreException;
136     
137     /**
138      * Removes the Session Delta from the file system without processing it.
139      *
140      * @since 2.0
141      * <p>
142      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
143      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
144      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
145      * (repeatedly) as the API evolves.
146      * </p>
147      */
148     public void delete();
149 }
150
Popular Tags