/*
 *  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
 *
 *      https://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.tools.ant.taskdefs;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;

Sleep, or pause, for a period of time.
A task for sleeping a short period of time, useful when a
build or deployment process requires an interval between tasks.
A negative value can be supplied to any of attributes provided the total sleep time
is positive, pending fundamental changes in physics and JVM
execution times
Note that sleep times are always hints to be interpreted by the OS how it feels
small times may either be ignored or rounded up to a minimum timeslice. Note
also that the system clocks often have a fairly low granularity too, which complicates
measuring how long a sleep actually took.
Since:
Ant 1.4
@ant.task
category="utility"/**
 * Sleep, or pause, for a period of time.
 *
 * <p>A task for sleeping a short period of time, useful when a
 * build or deployment process requires an interval between tasks.</p>
 *
 * <p>A negative value can be supplied to any of attributes provided the total sleep time
 * is positive, pending fundamental changes in physics and JVM
 * execution times</p>
 *
 * <p>Note that sleep times are always hints to be interpreted by the OS how it feels
 * small times may either be ignored or rounded up to a minimum timeslice. Note
 * also that the system clocks often have a fairly low granularity too, which complicates
 * measuring how long a sleep actually took.</p>
 *
 * @since Ant 1.4
 * @ant.task category="utility"
 */
public class Sleep extends Task {
    
failure flag
/**
     * failure flag
     */
    private boolean failOnError = true;

    
sleep seconds
/**
     * sleep seconds
     */
    private int seconds = 0;

    
sleep hours
/**
     * sleep hours
     */
    private int hours = 0;
    
sleep minutes
/**
     * sleep minutes
     */
    private int minutes = 0;

    
sleep milliseconds
/**
     * sleep milliseconds
     */
    private int milliseconds = 0;

    
Creates new instance
/**
     * Creates new instance
     */
    public Sleep() {
    }

    
seconds to add to the sleep time
Params:
seconds – The new Seconds value/**
     * seconds to add to the sleep time
     *
     * @param seconds The new Seconds value
     */
    public void setSeconds(int seconds) {
        this.seconds = seconds;
    }

    
hours to add to the sleep time.
Params:
hours – The new Hours value/**
     * hours to add to the sleep time.
     *
     * @param hours The new Hours value
     */
    public void setHours(int hours) {
        this.hours = hours;
    }

    
minutes to add to the sleep time
Params:
minutes – The new Minutes value/**
     * minutes to add to the sleep time
     *
     * @param minutes The new Minutes value
     */
    public void setMinutes(int minutes) {
        this.minutes = minutes;
    }

    
milliseconds to add to the sleep time
Params:
milliseconds – The new Milliseconds value/**
     * milliseconds to add to the sleep time
     *
     * @param milliseconds The new Milliseconds value
     */
    public void setMilliseconds(int milliseconds) {
        this.milliseconds = milliseconds;
    }

    
sleep for a period of time
Params:
millis – time to sleep/**
     * sleep for a period of time
     *
     * @param millis time to sleep
     */
    public void doSleep(long millis) {
        try {
            Thread.sleep(millis);
        } catch (InterruptedException ie) {
            // Ignore Exception
        }
    }

    
flag controlling whether to break the build on an error.
Params:
failOnError – The new FailOnError value/**
     * flag controlling whether to break the build on an error.
     *
     * @param failOnError The new FailOnError value
     */
    public void setFailOnError(boolean failOnError) {
        this.failOnError = failOnError;
    }

    
return time to sleep
Returns:
sleep time. if below 0 then there is an error/**
     * return time to sleep
     *
     * @return sleep time. if below 0 then there is an error
     */

    private long getSleepTime() {
        // CheckStyle:MagicNumber OFF
        return ((((long) hours * 60) + minutes) * 60 + seconds) * 1000
            + milliseconds;
        // CheckStyle:MagicNumber ON
    }

    
verify parameters
Throws:
BuildException – if something is invalid/**
     * verify parameters
     *
     * @throws BuildException if something is invalid
     */
    public void validate()
        throws BuildException {
        if (getSleepTime() < 0) {
            throw new BuildException("Negative sleep periods are not supported");
        }
    }

    
Executes this build task.
Throws:
BuildException – if there is an error during task execution/**
     * Executes this build task.
     *
     * @throws BuildException if there is an error during task execution
     */
    @Override
    public void execute()
        throws BuildException {
        try {
            validate();
            long sleepTime = getSleepTime();
            log("sleeping for " + sleepTime + " milliseconds",
                Project.MSG_VERBOSE);
            doSleep(sleepTime);
        } catch (Exception e) {
            if (failOnError) {
                throw new BuildException(e);
            }
            log(e.toString(), Project.MSG_ERR);
        }
    }

}