Package org.jjazz.musiccontrol.api.playbacksession

Interface UpdatableSongSession.UpdateProvider

All Known Implementing Classes:

UpdateProviderSongSession

Enclosing class:

UpdatableSongSession

public static interface UpdatableSongSession.UpdateProvider

A SongContextSession capability: can provide updates after sequence was generated (i.e. while session is in the GENERATED state).

Implementation must fire the relevant property change events.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_UPDATE_AVAILABLE	Property change event to be fired when a new update is available.
static final String	PROP_UPDATE_PROVISION_ENABLED	Property change event to be fired when updates can't be provided anymore.

Method Summary

Modifier and Type	Method	Description
UpdatableSongSession.Update	getLastUpdate()	Get the last available update after the PROP_UPDATE_AVAILABLE property change event was fired.
boolean	isUpdateProvisionEnabled()	Check if this UpdateProvider can still provide updates.

Field Details

PROP_UPDATE_AVAILABLE

static final String PROP_UPDATE_AVAILABLE

Property change event to be fired when a new update is available.

Note: event can be fired out of the Swing EDT.

See Also:

• Constant Field Values

PROP_UPDATE_PROVISION_ENABLED

static final String PROP_UPDATE_PROVISION_ENABLED

Property change event to be fired when updates can't be provided anymore.

See Also:

• Constant Field Values

Method Details

isUpdateProvisionEnabled

boolean isUpdateProvisionEnabled()

Check if this UpdateProvider can still provide updates.

Returns:

True upon this object's creation, but might become false if UpdateProvider is "too" dirty and not able anymore to provide updates.

See Also:

• PlaybackSession.isDirty()

getLastUpdate

UpdatableSongSession.Update getLastUpdate()

Get the last available update after the PROP_UPDATE_AVAILABLE property change event was fired.

Returns:

Can be null if PROP_UPDATE_AVAILABLE change event was never fired.