01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jdt.core;
11:
12: import org.eclipse.core.runtime.IPath;
13: import org.eclipse.core.runtime.IStatus;
14:
15: /**
16: * Represents the outcome of an Java model operation. Status objects are
17: * used inside <code>JavaModelException</code> objects to indicate what went
18: * wrong.
19: * <p>
20: * Java model status object are distinguished by their plug-in id:
21: * <code>getPlugin</code> returns <code>"org.eclipse.jdt.core"</code>.
22: * <code>getCode</code> returns one of the status codes declared in
23: * <code>IJavaModelStatusConstants</code>.
24: * </p>
25: * <p>
26: * A Java model status may also carry additional information (that is, in
27: * addition to the information defined in <code>IStatus</code>):
28: * <ul>
29: * <li>elements - optional handles to Java elements associated with the failure</li>
30: * <li>string - optional string associated with the failure</li>
31: * </ul>
32: * <p>
33: * This interface is not intended to be implemented by clients.
34: * </p>
35: *
36: * @see org.eclipse.core.runtime.IStatus
37: * @see IJavaModelStatusConstants
38: */
39: public interface IJavaModelStatus extends IStatus {
40: /**
41: * Returns any Java elements associated with the failure (see specification
42: * of the status code), or an empty array if no elements are related to this
43: * particular status code.
44: *
45: * @return the list of Java element culprits
46: * @see IJavaModelStatusConstants
47: */
48: IJavaElement[] getElements();
49:
50: /**
51: * Returns the path associated with the failure (see specification
52: * of the status code), or <code>null</code> if the failure is not
53: * one of <code>DEVICE_PATH</code>, <code>INVALID_PATH</code>,
54: * <code>PATH_OUTSIDE_PROJECT</code>, or <code>RELATIVE_PATH</code>.
55: *
56: * @return the path that caused the failure, or <code>null</code> if none
57: * @see IJavaModelStatusConstants#DEVICE_PATH
58: * @see IJavaModelStatusConstants#INVALID_PATH
59: * @see IJavaModelStatusConstants#PATH_OUTSIDE_PROJECT
60: * @see IJavaModelStatusConstants#RELATIVE_PATH
61: */
62: IPath getPath();
63:
64: /**
65: * Returns the string associated with the failure (see specification
66: * of the status code), or <code>null</code> if no string is related to this
67: * particular status code.
68: *
69: * @return the string culprit, or <code>null</code> if none
70: * @see IJavaModelStatusConstants
71: * @deprecated Use {@link IStatus#getMessage()} instead
72: */
73: String getString();
74:
75: /**
76: * Returns whether this status indicates that a Java model element does not exist.
77: * This convenience method is equivalent to
78: * <code>getCode() == IJavaModelStatusConstants.ELEMENT_DOES_NOT_EXIST</code>.
79: *
80: * @return <code>true</code> if the status code indicates that a Java model
81: * element does not exist
82: * @see IJavaModelStatusConstants#ELEMENT_DOES_NOT_EXIST
83: */
84: boolean isDoesNotExist();
85: }
|