A massive organize imports and formatting of the sources using default Eclipse code...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / core / IJavaModelStatus.java
index 6f55b0c..2df29b4 100644 (file)
@@ -14,9 +14,8 @@ import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IStatus;
 
 /**
- * Represents the outcome of an Java model operation. Status objects are
- * used inside <code>JavaModelException</code> objects to indicate what went
- * wrong.
+ * Represents the outcome of an Java model operation. Status objects are used
+ * inside <code>JavaModelException</code> objects to indicate what went wrong.
  * <p>
  * Java model status object are distinguished by their plug-in id:
  * <code>getPlugin</code> returns <code>"net.sourceforge.phpdt.core"</code>.
@@ -24,61 +23,63 @@ import org.eclipse.core.runtime.IStatus;
  * <code>IJavaModelStatusConstants</code>.
  * </p>
  * <p>
- * A Java model status may also carry additional information (that is, in 
+ * A Java model status may also carry additional information (that is, in
  * addition to the information defined in <code>IStatus</code>):
  * <ul>
- *   <li>elements - optional handles to Java elements associated with the failure</li>
- *   <li>string - optional string associated with the failure</li>
+ * <li>elements - optional handles to Java elements associated with the failure</li>
+ * <li>string - optional string associated with the failure</li>
  * </ul>
  * <p>
  * This interface is not intended to be implemented by clients.
  * </p>
- *
+ * 
  * @see org.eclipse.core.runtime.IStatus
  * @see IJavaModelStatusConstants
  */
 public interface IJavaModelStatus extends IStatus {
-/**
- * Returns any Java elements associated with the failure (see specification
- * of the status code), or an empty array if no elements are related to this
- * particular status code.
- *
- * @return the list of Java element culprits
- * @see IJavaModelStatusConstants
- */
-public IJavaElement[] getElements();
+       /**
+        * Returns any Java elements associated with the failure (see specification
+        * of the status code), or an empty array if no elements are related to this
+        * particular status code.
+        * 
+        * @return the list of Java element culprits
+        * @see IJavaModelStatusConstants
+        */
+       public IJavaElement[] getElements();
 
-/**
- * Returns the path associated with the failure (see specification
- * of the status code), or <code>null</code> if the failure is not 
- * one of <code>DEVICE_PATH</code>, <code>INVALID_PATH</code>, 
- * <code>PATH_OUTSIDE_PROJECT</code>, or <code>RELATIVE_PATH</code>.
- *
- * @return the path that caused the failure, or <code>null</code> if none
- * @see IJavaModelStatusConstants#DEVICE_PATH
- * @see IJavaModelStatusConstants#INVALID_PATH
- * @see IJavaModelStatusConstants#PATH_OUTSIDE_PROJECT
- * @see IJavaModelStatusConstants#RELATIVE_PATH
- */
-IPath getPath();
-/**
- * Returns the string associated with the failure (see specification
- * of the status code), or <code>null</code> if no string is related to this
- * particular status code.
- *
- * @return the string culprit, or <code>null</code> if none
- * @see IJavaModelStatusConstants
- * @deprecated Use IStatus#getMessage instead
- */
-String getString();
-/**
- * Returns whether this status indicates that a Java model element does not exist.
- * This convenience method is equivalent to
- * <code>getCode() == IJavaModelStatusConstants.ELEMENT_DOES_NOT_EXIST</code>.
- *
- * @return <code>true</code> if the status code indicates that a Java model
- *   element does not exist
- * @see IJavaModelStatusConstants#ELEMENT_DOES_NOT_EXIST
- */
-boolean isDoesNotExist();
+       /**
+        * Returns the path associated with the failure (see specification of the
+        * status code), or <code>null</code> if the failure is not one of
+        * <code>DEVICE_PATH</code>, <code>INVALID_PATH</code>,
+        * <code>PATH_OUTSIDE_PROJECT</code>, or <code>RELATIVE_PATH</code>.
+        * 
+        * @return the path that caused the failure, or <code>null</code> if none
+        * @see IJavaModelStatusConstants#DEVICE_PATH
+        * @see IJavaModelStatusConstants#INVALID_PATH
+        * @see IJavaModelStatusConstants#PATH_OUTSIDE_PROJECT
+        * @see IJavaModelStatusConstants#RELATIVE_PATH
+        */
+       IPath getPath();
+
+       /**
+        * Returns the string associated with the failure (see specification of the
+        * status code), or <code>null</code> if no string is related to this
+        * particular status code.
+        * 
+        * @return the string culprit, or <code>null</code> if none
+        * @see IJavaModelStatusConstants
+        * @deprecated Use IStatus#getMessage instead
+        */
+       String getString();
+
+       /**
+        * Returns whether this status indicates that a Java model element does not
+        * exist. This convenience method is equivalent to
+        * <code>getCode() == IJavaModelStatusConstants.ELEMENT_DOES_NOT_EXIST</code>.
+        * 
+        * @return <code>true</code> if the status code indicates that a Java
+        *         model element does not exist
+        * @see IJavaModelStatusConstants#ELEMENT_DOES_NOT_EXIST
+        */
+       boolean isDoesNotExist();
 }