Eclipse JDT
Release 3.0

org.eclipse.jdt.core.search
Class FieldReferenceMatch

java.lang.Object
  extended byorg.eclipse.jdt.core.search.SearchMatch
      extended byorg.eclipse.jdt.core.search.FieldReferenceMatch

public class FieldReferenceMatch
extends SearchMatch

A Java search match that represents a field reference. The element is the inner-most enclosing member that references this field.

This class is intended to be instantiated and subclassed by clients.

Since:
3.0

Field Summary
 
Fields inherited from class org.eclipse.jdt.core.search.SearchMatch
A_ACCURATE, A_INACCURATE
 
Constructor Summary
FieldReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, int length, boolean isReadAccess, boolean isWriteAccess, boolean insideDocComment, SearchParticipant participant, org.eclipse.core.resources.IResource resource)
          Creates a new field reference match.
 
Method Summary
 boolean isReadAccess()
          Returns whether the field reference is a read access to the field.
 boolean isWriteAccess()
          Returns whether the field reference is a write access to the field.
 
Methods inherited from class org.eclipse.jdt.core.search.SearchMatch
getAccuracy, getElement, getLength, getOffset, getParticipant, getResource, isInsideDocComment, setAccuracy, setElement, setInsideDocComment, setLength, setOffset, setParticipant, setResource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FieldReferenceMatch

public FieldReferenceMatch(IJavaElement enclosingElement,
                           int accuracy,
                           int offset,
                           int length,
                           boolean isReadAccess,
                           boolean isWriteAccess,
                           boolean insideDocComment,
                           SearchParticipant participant,
                           org.eclipse.core.resources.IResource resource)
Creates a new field reference match.

Parameters:
enclosingElement - the inner-most enclosing member that references this field
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
isReadAccess - whether the match represents a read access
isWriteAccess - whethre the match represents a write access
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
Method Detail

isReadAccess

public final boolean isReadAccess()
Returns whether the field reference is a read access to the field. Note that a field reference can be read and written at once in case of compound assignments (e.g. i += 0;)

Returns:
whether the field reference is a read access to the field.

isWriteAccess

public final boolean isWriteAccess()
Returns whether the field reference is a write access to the field. Note that a field reference can be read and written at once in case of compound assignments (e.g. i += 0;)

Returns:
whether the field reference is a write access to the field.

Eclipse JDT
Release 3.0

Copyright (c) IBM Corp. and others 2000, 2004. All Rights Reserved.