org.apache.flex.compiler.units.requests

Interface IRequest<T extends IRequestResult,U>

Type Parameters:

T - The type of the result of the request.

U - The type of the object on which the request is being made.

public interface IRequest<T extends IRequestResult,U>

Interface to all request objects obtained from methods on ICompilationUnit.

See Also:

ICompilationUnit

Method Summary

Methods

Modifier and Type	Method and Description
T	get() Blocks until requested operation is complete.
U	getRequestee() Get the object on which this request is being made.
long	getTimeStamp() Returns the time at which the request was first created.
boolean	isDone() Returns true if the requested operation is complete.

Method Detail

get

T get()
                             throws InterruptedException

Blocks until requested operation is complete.

Returns:

The result of the request.

Throws:

InterruptedException

isDone

boolean isDone()

Returns true if the requested operation is complete.

Returns:

true if the requested operation is complete, false otherwise.

getTimeStamp

long getTimeStamp()

Returns the time at which the request was first created. Consumers of the result of this request can use this time to determine if their cached results are still valid.

If the result of the request has been cached to disk, then the time returned from this method should be the time the request whose data was cached to disk was created. In other words, data cached to disk should contain the time stamp.

This method should return before the results of the request are available.

This method is used to propagate invalidations when using on disk caches containing request results from a previously run java process.

Returns:

A long value representing the time the request was created, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).

getRequestee

U getRequestee()

Get the object on which this request is being made.

Returns:

The object on which this request is being made.