org.aopalliance.reflect.Field Maven / Gradle / Ivy
package org.aopalliance.reflect;
/**
* This represents a field of a class. */
public interface Field extends Member {
/**
* Same as getReadLocator(USER_SIDE).
*
* @see #getReadLocator(int) */
CodeLocator getReadLocator();
/**
* This methods returns the points where the current field is read.
*
* There are two different behaviors for this method depending
* on the side of the locator. At the user side, the locator
* designates all the points in methods bodies where the field is
* read (similarly to Code.getReadLocator(Field)). At
* the provider side, it really may depend on the implementor
* choice (e.g. it can return a locator on the body of the field's
* getter).
*
*
In Java, the user side is most of the time used so that you
* can use the method getReadLocator().
*
* @param side USER_SIDE || PROVIDER_SIDE
* @see #getReadLocator() */
CodeLocator getReadLocator(int side);
/**
* Same as getWriteLocator(USER_SIDE).
*
* @see #getWriteLocator(int) */
CodeLocator getWriteLocator();
/**
* This methods returns the points where the current field is
* written.
*
*
There are two different behaviors for this method depending
* on the side of the locator. At the user side, the locator
* designates all the points in methods bodies where the field is
* written (similarly to Code.getWriteLocator(Field)). At
* the provider side, it really may depend on the implementor
* choice (e.g. it can return a locator on the body of the field's
* setter).
*
*
In Java, the user side is most of the time used so that you
* can use the method getWriteLocator().
*
* @param side USER_SIDE || PROVIDER_SIDE
* @see #getWriteLocator() */
CodeLocator getWriteLocator(int side);
}