com.dyngr.core.AttemptResults Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of polling Show documentation
A missing polling library for Java.
There is a newer version: 1.1.3
/*
 * Copyright 2012-2015 Ye Ding
 *
 * Licensed 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 com.dyngr.core;

import com.dyngr.exception.UserBreakException;

/**
 * Factory class for instances of {@link AttemptResult}.
 *
 * @author dingye
 */
public final class AttemptResults {
    /**
     * Return an {@link AttemptResult} that will end polling without result.
     *
     * @return an attempt result
     */
    public static AttemptResult justFinish() {
        return new AttemptResult(AttemptState.FINISH, null, "", null);
    }

    /**
     * Return an {@link AttemptResult} that will end polling with given result.
     *
     * @param result result of a successful attempt
     * @param   return type of poller
     * @return an attempt result
     */
    public static  AttemptResult finishWith(V result) {
        return new AttemptResult(AttemptState.FINISH, result, "", null);
    }

    /**
     * Return an {@link AttemptResult} that will break polling and throw an {@link UserBreakException}.
     *
     * @param message message about reason
     * @param   return type of poller
     * @return an attempt result
     */
    public static  AttemptResult breakFor(String message) {
        return new AttemptResult(AttemptState.BREAK, null, message, null);
    }

    /**
     * Return an {@link AttemptResult} that will break polling and throw an {@link UserBreakException}.
     *
     * @param cause reason of user break
     * @param   return type of poller
     * @return an attempt result
     */
    public static  AttemptResult breakFor(Throwable cause) {
        return new AttemptResult(AttemptState.BREAK, null, cause.getMessage(), cause);
    }

    /**
     * Return an {@link AttemptResult} that makes polling continue.
     *
     * @param  return type of poller
     * @return an attempt result
     */
    public static  AttemptResult justContinue() {
        return new AttemptResult(AttemptState.CONTINUE, null, "", null);
    }

    public static  AttemptResult continueFor(Throwable cause) {
        return new AttemptResult(AttemptState.CONTINUE, null, "", cause);
    }
}