diff options
Diffstat (limited to 'bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/infer/InferrenceProvider.java')
-rw-r--r-- | bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/infer/InferrenceProvider.java | 66 |
1 files changed, 20 insertions, 46 deletions
diff --git a/bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/infer/InferrenceProvider.java b/bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/infer/InferrenceProvider.java index d5dfc70c..d9621bd5 100644 --- a/bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/infer/InferrenceProvider.java +++ b/bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/infer/InferrenceProvider.java @@ -12,82 +12,56 @@ package org.eclipse.wst.jsdt.core.infer; /** - * Implemented by contributors to the - * org.eclipse.wst.jsdt.core.infer.inferrenceSupport extension point + * Implemented by contributors to the org.eclipse.wst.jsdt.core.infer.inferrenceSupport extension point * - * Provisional API: This class/interface is part of an interim API that is - * still under development and expected to change significantly before - * reaching stability. It is being made available at this early stage to - * solicit feedback from pioneering adopters on the understanding that any - * code that uses this API will almost certainly be broken (repeatedly) as the - * API evolves. + * Provisional API: This class/interface is part of an interim API that is still under development and expected to + * change significantly before reaching stability. It is being made available at this early stage to solicit feedback + * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken + * (repeatedly) as the API evolves. */ public interface InferrenceProvider { - + /** - * <p> - * Indicates that this InferrenceProvider, and its engine, are the - * <strong>only</strong> ones that should apply to a script file. - * </p> - * <p> - * Its use is discouraged. - * </p> + * <p>Indicates that this InferrenceProvider, and its engine, are the only ones that should apply.</p> + * <p>Its use is discouraged.</p> */ public static final int ONLY_THIS = 1; /** - * <p> - * Indicates that this InferrenceProvider, and its engine, do not apply to - * a script file. - * </p> + * <p>Indicates that this InferrenceProvider, and its engine, do not apply.</p> */ public static final int NOT_THIS = 2; - + /** - * <p> - * Indicates that this InferrenceProvider, and its engine, should - * <strong>also</strong> apply to a script file. As multiple providers may - * be required and used to completely understand a script file, this value - * is suggested as a default. Care should then be taken to avoid - * duplicating the contributions of the default provider. - * </p> + * <p>Indicates that this InferrenceProvider, and its engine, should apply to a script file.</p> */ public static final int MAYBE_THIS = 3; - + /** - * Get the inference engine for this inference provider, or null if one - * will not be provided. Implementors returning null are expected to have - * returned {@link #NOT_THIS} from all calls to {@link #getInferEngine()} - * + * Get the inference engine for this inference provider, or null if one will not be provided. Implementors returning null are expected to return {@link #NOT_THIS} for all calls to {@link #getInferEngine()} * @return an inference engine */ public IInferEngine getInferEngine(); - - + + /** * Determine if this inference provider applies to a script - * - * @param scriptFile - * the script on which the inferencing will be done - * @return {@link #ONLY_THIS}, {@link #NOT_THIS}, {@link #MAYBE_THIS} - * depending on how much this inference provider applies to the - * specified script. See the documentation for each constant for - * when each should be used. + * @param scriptFile The script that the inferencing will be done for + * @return {@link #ONLY_THIS}, {@link #NOT_THIS}, {@link #MAYBE_THIS} depending on how much + * this inference provider applies to the specified script. */ public int applysTo(IInferenceFile scriptFile); /** * Get the inference provider ID - * * @return the id of this inference provider */ public String getID(); - + /** - * @return the ResolutionConfiguration used to resolve the inferred - * classes + * @return the ResolutionConfiguration used to resolve the inferred classes */ public ResolutionConfiguration getResolutionConfiguration(); |