Class NiceRefreshHandler

src/main/java/org/htmlunit/NiceRefreshHandler.java:27–62

This refresh handler performs an immediate refresh if the refresh delay is less or equal to the configured time and otherwise ignores totally the refresh instruction. @author Marc Guillemot @author Ronald Brill

 * @author Ronald Brill
 */
public class NiceRefreshHandler extends ImmediateRefreshHandler {
    private final int maxDelay_;

    /**
     * Creates a new refresh handler that will immediately refresh if the refresh delay is no
     * longer than {@code maxDelay}. No refresh will be perform at all for refresh values
     * larger than {@code maxDelay}.
     *
     * @param maxDelay the maximum refreshValue (in seconds) that should cause a refresh
     */
    public NiceRefreshHandler(final int maxDelay) {
        super();
        if (maxDelay <= 0) {
            throw new IllegalArgumentException("Invalid maxDelay: " + maxDelay);
        }
        maxDelay_ = maxDelay;
    }

    /**
     * Refreshes the specified page using the specified URL immediately if the {@code requestedWait}
     * is not larger than the {@code maxDelay}. Does nothing otherwise.
     * @param page the page that is going to be refreshed
     * @param url the URL where the new page will be loaded
     * @param requestedWait the number of seconds to wait before reloading the page
     * @throws IOException if the refresh fails
     */
    @Override
    public void handleRefresh(final Page page, final URL url, final int requestedWait) throws IOException {
        if (requestedWait > maxDelay_) {
            return;
        }

        super.handleRefresh(page, url, requestedWait);
    }

}