com.moesif.api.controllers.syncwrapper.SynchronousBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moesifapi Show documentation

Java API Library for Moesif

The newest version!

/*
 * MoesifAPILib
 *
 *
 */
package com.moesif.api.controllers.syncwrapper;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

/**
 * Base class to help convert an asynchronous callback to synchronous one
 */
public class SynchronousBase {
    
    private CountDownLatch lock;
    
    /**
     * Initiate class with a task count
     * @param count Number of tasks we will wait on
     */
    public SynchronousBase(int count) {
        this.lock = new CountDownLatch(count);
    }
    
    /**
     * Initiate class with a count down of one only
     */
    public SynchronousBase() {
        this(1);
    }

    /**
     * Mark as done one task
     */
    protected void markAsDone()
    {
        lock.countDown();
    }
    
    /**
     * Wait until all tasks are marked as done
     * @throws InterruptedException error waiting for tasks to complete
     */
    public void await() throws InterruptedException {
        lock.await();
    }
    
    /**
     * Wait until all tasks are marked as done or timeout after given time
     * @param timeout Time to wait
     * @param unit    Unit for time
     * @return true if done
     * @throws InterruptedException error waiting for tasks to complete
     */
    public boolean await(long timeout, TimeUnit unit) throws InterruptedException {
        boolean t = lock.await(timeout, unit);
        return t;
    }
    
}