player
Interface SignsArrayAccess

public interface SignsArrayAccess

Interface defining client access to a SiGMLAnimation as an array of animated signs, which may be expanded on demand by the client, as new animation data becomes available. Moved from package sigmlanim, 2007-08-07.

Method Summary

boolean	arrayIsFinal() Returns this array-access's completion flag.
int	countFrames() Returns the number of available animation frames.
int	countSigns() Returns the number of valid signs in the array, i.e.
AnimatedSign[]	signs() Returns the currently available signs array.
void	update() Brings this array-access up to date with respect to the supporting animation, which may or may not change the array-access's state.
void	waitForProgress() Assuming animation frame generation is not complete, that is, assuming arrayIsFinal() returns false, this method blocks the caller until a significant update can be (and is) performed on this array-access.

Method Detail

signs

AnimatedSign[] signs()

Returns the currently available signs array.

countSigns

int countSigns()

Returns the number of valid signs in the array, i.e. the number of signs with animation frames attached.

countFrames

int countFrames()

Returns the number of available animation frames.

arrayIsFinal

boolean arrayIsFinal()

Returns this array-access's completion flag.

update

void update()

Brings this array-access up to date with respect to the supporting animation, which may or may not change the array-access's state.

waitForProgress

void waitForProgress()
                     throws java.lang.InterruptedException

Assuming animation frame generation is not complete, that is, assuming arrayIsFinal() returns false, this method blocks the caller until a significant update can be (and is) performed on this array-access. When the call returns either there are more valid entries in the array or the array-access is flagged as complete.

Throws:

java.lang.InterruptedException