package votorola.g.web.gwt.event; // Copyright 2011, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import com.google.gwt.core.client.Scheduler;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HasHandlers;
import java.util.*;


/** A scheduler for the delayed dispatch of events.  Use it to both delay the dispatch of
  * events and to group multiple events into a single, atomic dispatch.
  */
public class DelayedEventGun extends CoalescingSchedulerS implements Scheduler.ScheduledCommand
{


    /** Constructs a new DelayedEventGun.
      *
      *     @see #source()
      *     @see #phaser()
      */
    public DelayedEventGun( HasHandlers _source, Phaser _phaser )
    {
        super( Scheduler.get(), _phaser );
        source = _source;
        init( /*command*/DelayedEventGun.this );
    }



   // ------------------------------------------------------------------------------------


    /** Immediately dispatches all scheduled events.
      */
    public final void flush() { execute(); }



    /** Adds the specified event to the dispatch list and ensures that the dispatcher is
      * scheduled to execute.
      *
      *     @see #schedule()
      */
    public void schedule( final GwtEvent<?> e )
    {
        eList.add( e );
        schedule();
    }



    /** The source from which the events are to be fired.
      */
    public final HasHandlers source() { return source; }


        private final HasHandlers source;



   // - S c h e d u l e r . S c h e d u l e d - C o m m a n d ----------------------------


    public final void execute()
    {
        final GwtEvent<?>[] events = eList.toArray( new GwtEvent<?>[eList.size()] );
        eList.clear(); // atomic copy/clear, simpler than concurrent modification via iterator
        for( final GwtEvent<?> e: events ) source.fireEvent( e );
    }



//// P r i v a t e ///////////////////////////////////////////////////////////////////////


    private final ArrayList<GwtEvent<?>> eList = new ArrayList<GwtEvent<?>>( /*initial capacity*/4 );


}