com.github.slem1.await.PollingConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of await-maven-plugin Show documentation

A plugin to pause maven build until some services become available.

There is a newer version: 1.2.2

package com.github.slem1.await;

/**
 * The polling configuration which allows to configure {@link PollingTask}.
 *
 * @author slemoine
 */
public class PollingConfig {

    private int attempts = 3;

    private int sleep = 1000;

    /**
     * Default constructor used by maven
     */
    public PollingConfig() {
    }

    /**
     * Initialize the polling configuration with {@code attempts} and {@code sleep} waiting time in milliseconds between
     * two attempts.
     *
     * @param attempts the max number of connection attempts.
     * @param sleep    the waiting time in ms.
     */
    public PollingConfig(int attempts, int sleep) {
        validate(attempts, sleep);
        this.attempts = attempts;
        this.sleep = sleep;
    }

    /**
     * Return the number of attempt.
     *
     * @return the number of attempts.
     */
    public int getAttempts() {
        return attempts;
    }

    /**
     * Return the waiting time between two attempts of connection.
     *
     * @return the waiting time
     */
    public int getSleep() {
        return sleep;
    }

    /**
     * Validates this configuration.
     *
     * @return this configuration.
     * @throws IllegalArgumentException if the configuration is invalid.
     */
    public PollingConfig validate() {
        validate(attempts, sleep);
        return this;
    }

    private void validate(int attempts, int sleep) {
        if (attempts < 1) {
            throw new IllegalArgumentException("attempts must be >= 1");
        }

        if (sleep < 0) {
            throw new IllegalArgumentException("sleep cannot be negative");
        }
    }
}