org.apache.excalibur.event.command.DelayedCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of excalibur-event-api Show documentation

Excalibur Event API

The newest version!

/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed  under the  License is distributed on an "AS IS" BASIS,
 * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
 * implied.
 * 
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.excalibur.event.command;

/**
 * A DelayedCommand is a specific type of Command that denotes a an execution
 * unit that will be delayed at least X number of milliseconds.  The
 * mechanism is not guaranteed to be deterministic.
 *
 * @author Avalon Development Team
 */
public interface DelayedCommand extends Command
{
    /**
     * Sets the initial delay for the Command.  This defaults to 0
     * milliseconds.  The value must be positive.
     *
     * @return the number of milliseconds to delay
     */
    long getDelayInterval();
}