com.techempower.scheduler.OnDemandEvent Maven / Gradle / Ivy
Show all versions of gemini Show documentation
/*******************************************************************************
* Copyright (c) 2018, TechEmpower, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name TechEmpower, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL TECHEMPOWER, INC. BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
package com.techempower.scheduler;
/**
* An event that is never intended to be executed on a schedule. It will only
* ever be executed on demand or, should you wait long enough, in the amazing
* year four hundred billion!
*
* This is a convenience subclass to ScheduledEvent that leaves you to
* implement a call to the constructor and a method named "doIt" where you do
* your business.
*/
public abstract class OnDemandEvent
extends ScheduledEvent
{
//
// Member methods.
//
/**
* Constructor.
*/
public OnDemandEvent(String name, String description)
{
super(name, description);
}
/**
* Executes this event.
*/
@Override
public void execute(Scheduler scheduler, boolean onDemandExecution)
{
doIt();
}
@Override
public long getScheduledTime()
{
// Far in the future.
return Long.MAX_VALUE;
}
/**
* Subclasses implement this to do their business.
*/
protected abstract void doIt();
}