TimedTrigger.java

package se.l4.vibe.trigger;

import se.l4.vibe.builder.TriggerBuilder;

/**
 * Special extension to {@link Trigger} that helps with getting a default
 * repeat time. 
 * 
 * See {@link TriggerBuilder#atMostEvery(long, java.util.concurrent.TimeUnit)}.
 * 
 * @author Andreas Holstenson
 *
 */
public interface TimedTrigger<Input, Output>
	extends Trigger<Input, Output>
{
	/**
	 * Get the default time to repeat events on.
	 * 
	 * @return
	 * 	default time to repeat trigger action in milliseconds. Return
	 * 	{@code 0} to set to sample time. 
	 */
	long getDefaultRepeatTime();
}