Copyright (c) 2000, 2009 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
IBM Corporation - initial API and implementation
/*******************************************************************************
* Copyright (c) 2000, 2009 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.core.search;
import org.eclipse.core.resources.IResource;
import org.eclipse.jdt.core.*;
A Java search match that represents a type reference.
The element is the inner-most enclosing member that references this type.
This class is intended to be instantiated and subclassed by clients.
Since: 3.0
/**
* A Java search match that represents a type reference.
* The element is the inner-most enclosing member that references this type.
* <p>
* This class is intended to be instantiated and subclassed by clients.
* </p>
*
* @since 3.0
*/
public class TypeReferenceMatch extends ReferenceMatch {
private IJavaElement[] otherElements;
Creates a new type reference match.
Params: - enclosingElement – the inner-most enclosing member that references this type
- accuracy – one of
SearchMatch.A_ACCURATE or SearchMatch.A_INACCURATE - offset – the offset the match starts at, or -1 if unknown
- length – the length of the match, or -1 if unknown
- insideDocComment –
true if this search match is inside a doc
comment, and false otherwise - participant – the search participant that created the match
- resource – the resource of the element
/**
* Creates a new type reference match.
*
* @param enclosingElement the inner-most enclosing member that references this type
* @param accuracy one of {@link #A_ACCURATE} or {@link #A_INACCURATE}
* @param offset the offset the match starts at, or -1 if unknown
* @param length the length of the match, or -1 if unknown
* @param insideDocComment <code>true</code> if this search match is inside a doc
* comment, and <code>false</code> otherwise
* @param participant the search participant that created the match
* @param resource the resource of the element
*/
public TypeReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, int length, boolean insideDocComment, SearchParticipant participant, IResource resource) {
super(enclosingElement, accuracy, offset, length, insideDocComment, participant, resource);
}
Returns other elements also enclosing the type reference. This typically can
happen for multiple fields or local variable declarations.
For example,
- searching for the references to the type
Test in
public class Test {
Test test1, test2, test3;
void method() {}
}
will return one match whose other elements is an array of two fields: test2 and test3.
- searching for the references to the type
Test in
public class Test {
String str;
void method() {
Test local1, local2, local3;
}
}
will return one match whose other elements is an array of two local variables: local2 and local3.
- since 3.6, searching for the references to the type
Test in
public class Test {
void testB(int testKind) {
@Annot int test1, test2;
}
}
@interface Annot {}
will return one match whose other elements is an array of one annotation: Annot which parent is the local variable test2.
Returns: the other elements of the search match, or null if none Since: 3.2
/**
* Returns other elements also enclosing the type reference. This typically can
* happen for multiple fields or local variable declarations.
*<p>
* For example,
* <ul>
* <li>searching for the references to the type <code>Test</code> in
* <pre>
* public class Test {
* Test test1, test2, test3;
* void method() {}
* }
* </pre>
* will return one match whose other elements is an array of two fields:
* {@link IField test2} and {@link IField test3}.
* <br><br>
* </li>
* <li>searching for the references to the type <code>Test</code> in
* <pre>
* public class Test {
* String str;
* void method() {
* Test local1, local2, local3;
* }
* }
* </pre>
* will return one match whose other elements is an array of two local
* variables: {@link ILocalVariable local2} and {@link ILocalVariable local3}.
* <br><br>
* </li>
* <li>since 3.6, searching for the references to the type
* <code>Test</code> in
* <pre>
* public class Test {
* void testB(int testKind) {
* @Annot int test1, test2;
* }
* }
* @interface Annot {}
* </pre>
* will return one match whose other elements is an array of one annotation:
* {@link IAnnotation Annot} which parent is the local variable
* {@link ILocalVariable test2}.
* </li>
* </ul>
*
* @return the other elements of the search match, or <code>null</code> if none
* @since 3.2
*/
public final IJavaElement[] getOtherElements() {
return this.otherElements;
}
Sets the other elements of this search match.
Params: - otherElements – the other elements of the match,
or
null if none
See Also: - getOtherElements()
Since: 3.2
/**
* Sets the other elements of this search match.
*
* @see #getOtherElements()
*
* @param otherElements the other elements of the match,
* or <code>null</code> if none
* @since 3.2
*/
public final void setOtherElements(IJavaElement[] otherElements) {
this.otherElements = otherElements;
}
}