org.eclipse.equinox.internal.provisional.p2.updatechecker

Interface IUpdateChecker

All Known Implementing Classes:

UpdateChecker

public interface IUpdateChecker

An update checker periodically polls for updates to specified profiles and informs listeners if updates are available. Listeners may then determine whether to retrieve the updates, inform the user, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ONE_TIME_CHECK
static java.lang.String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
void	addUpdateCheck(java.lang.String profileId, <any> iusToCheckQuery, long delay, long poll, IUpdateListener listener) Adds an update listener that will be notified when updates are available for all installable units that satisfy the given query.
void	removeUpdateCheck(IUpdateListener listener) Removes an update listener from the set of listeners registered with this update checker.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

ONE_TIME_CHECK

static final long ONE_TIME_CHECK

See Also:

Constant Field Values

Method Detail

addUpdateCheck

void addUpdateCheck(java.lang.String profileId,
                    <any> iusToCheckQuery,
                    long delay,
                    long poll,
                    IUpdateListener listener)

Adds an update listener that will be notified when updates are available for all installable units that satisfy the given query. The listener will remain registered until removed using the removeUpdateCheck(IUpdateListener) method. Adding a listener that is identical to a listener that is already registered has no effect.

Once the listener is registered, it will continue to receive notification of updates based on the specified polling frequency. However, if a delay value of ONE_TIME_CHECK is used, only a single update check will occur for that listener. If this delay value is used, the specified polling frequency is ignored.

Parameters:

profileId - The profile id to check for updates

iusToCheckQuery - An installable unit query that matches the units to check for updates

delay - The delay in milliseconds before the first query should occur, or ONE_TIME_CHECK to indicate that a single update check should occur immediately

poll - The polling frequency, in milliseconds, between checks for updates

listener - The listener to be notified of updates

See Also:

removeUpdateCheck(IUpdateListener)

removeUpdateCheck

void removeUpdateCheck(IUpdateListener listener)

Removes an update listener from the set of listeners registered with this update checker. If an update check is currently in progress the listener may still receive events after this method returns. Removing a listener that is not registered has no effect.

Parameters:

listener - The listener to remove

See Also:

#addUpdateCheck(String, IQuery, long, long, IUpdateListener)