1 /*******************************************************************************
2 * Copyright (c) 2000, 2004 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Common Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/cpl-v10.html
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 package net.sourceforge.phpdt.core.search;
13 //import net.sourceforge.phpdt.internal.core.search.processing.*;
17 * This interface defines the constants used by the search engine.
20 * This interface declares constants only; it is not intended to be implemented.
22 * @see org.eclipse.jdt.core.search.SearchEngine
24 public interface IJavaSearchConstants {
27 * The nature of searched element or the nature
28 * of match in unknown.
32 /* Nature of searched element */
35 * The searched element is a type.
40 * The searched element is a method.
45 * The searched element is a package.
50 * The searched element is a constructor.
55 * The searched element is a field.
60 * The searched element is a class.
61 * More selective than using TYPE
66 * The searched element is an interface.
67 * More selective than using TYPE
74 * The search result is a declaration.
75 * Can be used in conjunction with any of the nature of searched elements
76 * so as to better narrow down the search.
81 * The search result is a type that implements an interface.
82 * Used in conjunction with either TYPE or CLASS or INTERFACE, it will
83 * respectively search for any type implementing/extending an interface, or
84 * rather exclusively search for classes implementing an interface, or interfaces
85 * extending an interface.
90 * The search result is a reference.
91 * Can be used in conjunction with any of the nature of searched elements
92 * so as to better narrow down the search.
93 * References can contain implementers since they are more generic kind
99 * The search result is a declaration, a reference, or an implementer
101 * Can be used in conjunction with any of the nature of searched elements
102 * so as to better narrow down the search.
104 int ALL_OCCURRENCES= 3;
107 * When searching for field matches, it will exclusively find read accesses, as
108 * opposed to write accesses. Note that some expressions are considered both
109 * as field read/write accesses: for example, x++; x+= 1;
113 int READ_ACCESSES = 4;
116 * When searching for field matches, it will exclusively find write accesses, as
117 * opposed to read accesses. Note that some expressions are considered both
118 * as field read/write accesses: for example, x++; x+= 1;
122 int WRITE_ACCESSES = 5;
124 /* Syntactic match modes */
127 * The search pattern matches exactly the search result,
128 * that is, the source of the search result equals the search pattern.
129 * @deprecated Use {@link SearchPattern#R_EXACT_MATCH} instead.
133 * The search pattern is a prefix of the search result.
134 * @deprecated Use {@link SearchPattern#R_PREFIX_MATCH} instead.
136 int PREFIX_MATCH = 1;
138 * The search pattern contains one or more wild cards ('*') where a
139 * wild-card can replace 0 or more characters in the search result.
140 * @deprecated Use {@link SearchPattern#R_PATTERN_MATCH} instead.
142 int PATTERN_MATCH = 2;
145 /* Case sensitivity */
148 * The search pattern matches the search result only
149 * if cases are the same.
150 * @deprecated Use the methods that take the matchMode
151 * with {@link SearchPattern#R_CASE_SENSITIVE} as a matchRule instead.
153 boolean CASE_SENSITIVE = true;
155 * The search pattern ignores cases in the search result.
156 * @deprecated Use the methods that take the matchMode
157 * without {@link SearchPattern#R_CASE_SENSITIVE} as a matchRule instead.
159 boolean CASE_INSENSITIVE = false;
162 /* Waiting policies */
165 * The search operation starts immediately, even if the underlying indexer
166 * has not finished indexing the workspace. Results will more likely
167 * not contain all the matches.
169 // int FORCE_IMMEDIATE_SEARCH = IJob.ForceImmediate;
171 * The search operation throws an <code>org.eclipse.core.runtime.OperationCanceledException</code>
172 * if the underlying indexer has not finished indexing the workspace.
174 // int CANCEL_IF_NOT_READY_TO_SEARCH = IJob.CancelIfNotReady;
176 * The search operation waits for the underlying indexer to finish indexing
177 * the workspace before starting the search.
179 // int WAIT_UNTIL_READY_TO_SEARCH = IJob.WaitUntilReady;