NotEnoughPermutationsException.java

package com.hida.model;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

/**
 * An exception used to display how many permutations actually remain and the
 * requested amount that caused an error.
 *
 * @author lruffin
 */
@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason
        = "Requested amount exceeds possible number "
        + "of permutations")
public class NotEnoughPermutationsException extends RuntimeException {

    private long remainingPermutations_;
    private long requestedAmount_;

    public NotEnoughPermutationsException(long remaining, long requested) {
        this.remainingPermutations_ = remaining;
        this.requestedAmount_ = requested;
    }

    /**
     * Creates a new instance of <code>TooManyPermutationsException</code>
     * without detail message.
     */
    public NotEnoughPermutationsException() {
    }

    @Override
    public String getMessage() {
        return String.format("%d ids were requested but only %d can be created using given format",
                requestedAmount_, remainingPermutations_);
    }
}