org.apache.brooklyn.util.time.Durations Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of brooklyn-utils-common Show documentation

Utility classes and methods developed for Brooklyn but not dependendent on Brooklyn or much else

There is a newer version: 1.1.0

Show 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.brooklyn.util.time;

import java.util.concurrent.CancellationException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import org.apache.brooklyn.util.exceptions.Exceptions;
import org.apache.brooklyn.util.guava.Maybe;

public class Durations {

    public static boolean await(CountDownLatch latch, Duration time) throws InterruptedException {
        return latch.await(time.toNanoseconds(), TimeUnit.NANOSECONDS);
    }
    
    public static void join(Thread thread, Duration time) throws InterruptedException {
        thread.join(time.toMillisecondsRoundingUp());
    }

    public static  Maybe get(Future t, Duration timeout) {
        try {
            if (timeout==null || timeout.toMilliseconds()<0 || Duration.PRACTICALLY_FOREVER.equals(timeout))
                return Maybe.of(t.get());
            if (timeout.toMilliseconds()==0 && !t.isDone()) {
                for (int i=0; i<10; i++) {
                    // give it 10 nanoseconds to complete - heuristically this is often enough
                    // (Thread.yield should do it, but often seems to have no effect, e.g. on Mac)
                    Thread.yield();
                    Thread.sleep(0, 1);
                }
                if (t.isDone()) {
                    return Maybe.of(t.get());
                } else {
                    return Maybe.absent("Task "+t+" not completed when immediate completion requested");
                }
            }
            return Maybe.of(t.get(timeout.toMilliseconds(), TimeUnit.MILLISECONDS));
        } catch (TimeoutException e) {
            return Maybe.absent("Task "+t+" did not complete within "+timeout);
        } catch (CancellationException e) {
            return Maybe.absent("Task "+t+" was cancelled");
        } catch (Exception e) {
            throw Exceptions.propagate(e);
        }
    }

    public static  Maybe get(Future t, CountdownTimer timer) {
        if (timer==null) return get(t, (Duration)null);
        Duration remaining = timer.getDurationRemaining();
        if (remaining.isPositive()) return get(t, remaining);
        return get(t, Duration.ZERO);
    }
    
}