IResourceStatus


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.core.resources;
12  
13  import org.eclipse.core.runtime.*;
14  
15  /**
16   * Represents status related to resources in the Resources plug-in and
17   * defines the relevant status code constants.
18   * Status objects created by the Resources plug-in bear its unique id
19   * (<code>ResourcesPlugin.PI_RESOURCES</code>) and one of
20   * these status codes.
21   * <p>
22   * This interface is not intended to be implemented by clients.
23   * </p>
24   *
25   * @see org.eclipse.core.runtime.IStatus
26   * @see ResourcesPlugin#PI_RESOURCES
27   */
28  public interface IResourceStatus extends IStatus {
29  
30      /*
31       * Status code definitions
32       */
33  
34      // General constants [0-98]
35      // Information Only [0-32]
36      // Warnings [33-65]
37      /** Status code constant (value 35) indicating that a given 
38       * nature set does not satisfy its constraints.
39       * Severity: warning. Category: general.
40       */
41      public static final int INVALID_NATURE_SET = 35;
42  
43      // Errors [66-98]
44  
45      /** Status code constant (value 75) indicating that a builder failed.
46       * Severity: error. Category: general.
47       */
48      public static final int BUILD_FAILED = 75;
49  
50      /** Status code constant (value 76) indicating that an operation failed.
51       * Severity: error. Category: general.
52       */
53      public static final int OPERATION_FAILED = 76;
54  
55      /** Status code constant (value 77) indicating an invalid value.
56       * Severity: error. Category: general.
57       */
58      public static final int INVALID_VALUE = 77;
59  
60      // Local file system constants [200-298]
61      // Information Only [200-232]
62  
63      // Warnings [233-265]
64  
65      /** Status code constant (value 234) indicating that a project
66       * description file (.project), was missing but it has been repaired.
67       * Severity: warning. Category: local file system.
68       */
69      public static final int MISSING_DESCRIPTION_REPAIRED = 234;
70  
71      /** Status code constant (value 235) indicating the local file system location
72       * for a resource overlaps the location of another resource.
73       * Severity: warning. Category: local file system.
74       */
75      public static final int OVERLAPPING_LOCATION = 235;
76  
77      // Errors [266-298]
78  
79      /** Status code constant (value 268) indicating a resource unexpectedly 
80       * exists on the local file system.
81       * Severity: error. Category: local file system.
82       */
83      public static final int EXISTS_LOCAL = 268;
84  
85      /** Status code constant (value 269) indicating a resource unexpectedly 
86       * does not exist on the local file system.
87       * Severity: error. Category: local file system.
88       */
89      public static final int NOT_FOUND_LOCAL = 269;
90  
91      /** Status code constant (value 270) indicating the local file system location for
92       * a resource could not be computed. 
93       * Severity: error. Category: local file system.
94       */
95      public static final int NO_LOCATION_LOCAL = 270;
96  
97      /** Status code constant (value 271) indicating an error occurred while
98       * reading part of a resource from the local file system.
99       * Severity: error. Category: local file system.
100      */
101     public static final int FAILED_READ_LOCAL = 271;
102 
103     /** Status code constant (value 272) indicating an error occurred while
104      * writing part of a resource to the local file system.
105      * Severity: error. Category: local file system.
106      */
107     public static final int FAILED_WRITE_LOCAL = 272;
108 
109     /** Status code constant (value 273) indicating an error occurred while
110      * deleting a resource from the local file system.
111      * Severity: error. Category: local file system.
112      */
113     public static final int FAILED_DELETE_LOCAL = 273;
114 
115     /** Status code constant (value 274) indicating the workspace view of
116      * the resource differs from that of the local file system.  The requested
117      * operation has been aborted to prevent the possible loss of data.
118      * Severity: error. Category: local file system.
119      */
120     public static final int OUT_OF_SYNC_LOCAL = 274;
121 
122     /** Status code constant (value 275) indicating this file system is not case
123      * sensitive and a resource that differs only in case unexpectedly exists on 
124      * the local file system.
125      * Severity: error. Category: local file system.
126      */
127     public static final int CASE_VARIANT_EXISTS = 275;
128 
129     /** Status code constant (value 276) indicating a file exists in the
130      * file system but is not of the expected type (file instead of directory,
131      * or vice-versa).
132      * Severity: error. Category: local file system.
133      */
134     public static final int WRONG_TYPE_LOCAL = 276;
135 
136     /** Status code constant (value 277) indicating that the parent
137      * file in the file system is marked as read-only.
138      * Severity: error. Category: local file system.
139      * @since 2.1
140      */
141     public static final int PARENT_READ_ONLY = 277;
142 
143     /** Status code constant (value 278) indicating a file exists in the
144      * file system but its name is not a valid resource name.
145      * Severity: error. Category: local file system.
146      */
147     public static final int INVALID_RESOURCE_NAME = 278;
148 
149     /** Status code constant (value 279) indicating that the 
150      * file in the file system is marked as read-only.
151      * Severity: error. Category: local file system.
152      * @since 3.0
153      */
154     public static final int READ_ONLY_LOCAL = 279;
155 
156     // Workspace constants [300-398]
157     // Information Only [300-332]
158 
159     // Warnings [333-365]
160 
161     /** Status code constant (value 333) indicating that a workspace path 
162      * variable unexpectedly does not exist.
163      *  Severity: warning. Category: workspace.
164      * @since 2.1
165      */
166     public static final int VARIABLE_NOT_DEFINED_WARNING = 333;
167 
168     // Errors [366-398]
169 
170     /** Status code constant (value 366) indicating a resource exists in the
171      * workspace but is not of the expected type.
172      * Severity: error. Category: workspace.
173      */
174     public static final int RESOURCE_WRONG_TYPE = 366;
175 
176     /** Status code constant (value 367) indicating a resource unexpectedly 
177      * exists in the workspace.
178      * Severity: error. Category: workspace.
179      */
180     public static final int RESOURCE_EXISTS = 367;
181 
182     /** Status code constant (value 368) indicating a resource unexpectedly 
183      * does not exist in the workspace.
184      * Severity: error. Category: workspace.
185      */
186     public static final int RESOURCE_NOT_FOUND = 368;
187 
188     /** Status code constant (value 369) indicating a resource unexpectedly 
189      * does not have content local to the workspace.
190      * Severity: error. Category: workspace.
191      */
192     public static final int RESOURCE_NOT_LOCAL = 369;
193 
194     /** Status code constant (value 370) indicating a workspace
195      * is unexpectedly closed.
196      * Severity: error. Category: workspace.
197      */
198     public static final int WORKSPACE_NOT_OPEN = 370;
199 
200     /** Status code constant (value 372) indicating a project is
201      * unexpectedly closed.
202      * Severity: error. Category: workspace.
203      */
204     public static final int PROJECT_NOT_OPEN = 372;
205 
206     /** Status code constant (value 374) indicating that the path
207      * of a resource being created is occupied by an existing resource
208      * of a different type.
209      * Severity: error. Category: workspace.
210      */
211     public static final int PATH_OCCUPIED = 374;
212 
213     /** Status code constant (value 375) indicating that the sync partner
214      * is not registered with the workspace synchronizer.
215      * Severity: error. Category: workspace.
216      */
217     public static final int PARTNER_NOT_REGISTERED = 375;
218 
219     /** Status code constant (value 376) indicating a marker unexpectedly 
220      * does not exist in the workspace tree.
221      * Severity: error. Category: workspace.
222      */
223     public static final int MARKER_NOT_FOUND = 376;
224 
225     /** Status code constant (value 377) indicating a resource is 
226      * unexpectedly not a linked resource.
227      * Severity: error. Category: workspace.
228      * @since 2.1
229      */
230     public static final int RESOURCE_NOT_LINKED = 377;
231 
232     /** Status code constant (value 378) indicating that linking is
233      * not permitted on a certain project.
234      * Severity: error. Category: workspace.
235      * @since 2.1
236      */
237     public static final int LINKING_NOT_ALLOWED = 378;
238 
239     /** Status code constant (value 379) indicating that a workspace path 
240      * variable unexpectedly does not exist.
241      *  Severity: error. Category: workspace.
242      * @since 2.1
243      */
244     public static final int VARIABLE_NOT_DEFINED = 379;
245 
246     /** Status code constant (value 380) indicating that an attempt was made to modify 
247      * the workspace while it was locked.  Resource changes are disallowed
248      * during certain types of resource change event notification. 
249      * Severity: error. Category: workspace.
250      * @see IResourceChangeEvent
251      * @since 2.1
252      */
253     public static final int WORKSPACE_LOCKED = 380;
254     
255     /** Status code constant (value 381) indicating that a problem occurred while
256      * retrieving the content description for a resource.
257      * Severity: error. Category: workspace.
258      * @see IFile#getContentDescription
259      * @since 3.0 
260      */
261     public static final int FAILED_DESCRIBING_CONTENTS = 381;   
262 
263     /** Status code constant (value 382) indicating that a problem occurred while
264      * setting the charset for a resource.
265      * Severity: error. Category: workspace.
266      * @see IContainer#setDefaultCharset(String, IProgressMonitor)
267      * @see IFile#setCharset(String, IProgressMonitor)
268      * @since 3.0 
269      */
270     public static final int FAILED_SETTING_CHARSET = 382;
271     
272     /** Status code constant (value 383) indicating that a problem occurred while
273      * getting the charset for a resource.
274      * Severity: error. Category: workspace.
275      * @since 3.0 
276      */
277     public static final int FAILED_GETTING_CHARSET = 383;   
278 
279     // Internal constants [500-598]
280     // Information Only [500-532]
281 
282     // Warnings [533-565]
283 
284     // Errors [566-598]
285 
286     /** Status code constant (value 566) indicating an error internal to the
287      * platform has occurred.
288      * Severity: error. Category: internal.
289      */
290     public static final int INTERNAL_ERROR = 566;
291 
292     /** Status code constant (value 567) indicating the platform could not read
293      * some of its metadata.
294      * Severity: error. Category: internal.
295      */
296     public static final int FAILED_READ_METADATA = 567;
297 
298     /** Status code constant (value 568) indicating the platform could not write
299      * some of its metadata.
300      * Severity: error. Category: internal.
301      */
302     public static final int FAILED_WRITE_METADATA = 568;
303 
304     /** Status code constant (value 569) indicating the platform could not delete
305      * some of its metadata.
306      * Severity: error. Category: internal.
307      */
308     public static final int FAILED_DELETE_METADATA = 569;
309 
310     /**
311      * Returns the path of the resource associated with this status.
312      *
313      * @return the path of the resource related to this status
314      */
315     public IPath getPath();
316 }
317
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Free Books Free Magazines
Popular Tags