X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IJavaModelStatus.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IJavaModelStatus.java index 27a8452..2df29b4 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IJavaModelStatus.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IJavaModelStatus.java @@ -1,22 +1,21 @@ /******************************************************************************* - * Copyright (c) 2000, 2001, 2002 International Business Machines Corp. and others. + * Copyright (c) 2000, 2003 IBM Corporation and others. * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Common Public License v0.5 + * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/cpl-v05.html + * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: * IBM Corporation - initial API and implementation - ******************************************************************************/ + *******************************************************************************/ package net.sourceforge.phpdt.core; 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 JavaModelException objects to indicate what went - * wrong. + * Represents the outcome of an Java model operation. Status objects are used + * inside JavaModelException objects to indicate what went wrong. *

* Java model status object are distinguished by their plug-in id: * getPlugin returns "net.sourceforge.phpdt.core". @@ -24,59 +23,63 @@ import org.eclipse.core.runtime.IStatus; * IJavaModelStatusConstants. *

*

- * 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 IStatus): *

*

* This interface is not intended to be implemented by clients. *

- * + * * @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 - */ -IJavaElement[] getElements(); -/** - * Returns the path associated with the failure (see specification - * of the status code), or null if the failure is not - * one of DEVICE_PATH, INVALID_PATH, - * PATH_OUTSIDE_PROJECT, or RELATIVE_PATH. - * - * @return the path that caused the failure, or null 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 null if no string is related to this - * particular status code. - * - * @return the string culprit, or null if none - * @see IJavaModelStatusConstants - */ -String getString(); -/** - * Returns whether this status indicates that a Java model element does not exist. - * This convenience method is equivalent to - * getCode() == IJavaModelStatusConstants.ELEMENT_DOES_NOT_EXIST. - * - * @return true if the status code indicates that a Java model - * element does not exist - * @see IJavaModelStatusConstants#ELEMENT_DOES_NOT_EXIST - */ -boolean isDoesNotExist(); + /** + * 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 null if the failure is not one of + * DEVICE_PATH, INVALID_PATH, + * PATH_OUTSIDE_PROJECT, or RELATIVE_PATH. + * + * @return the path that caused the failure, or null 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 null if no string is related to this + * particular status code. + * + * @return the string culprit, or null 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 + * getCode() == IJavaModelStatusConstants.ELEMENT_DOES_NOT_EXIST. + * + * @return true if the status code indicates that a Java + * model element does not exist + * @see IJavaModelStatusConstants#ELEMENT_DOES_NOT_EXIST + */ + boolean isDoesNotExist(); }