io.dropwizard.configuration.ConfigurationException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dropwizard-configuration Show documentation
The newest version!
package io.dropwizard.configuration;

import java.util.Collection;

/**
 * Base class for problems with a Configuration object.
 * 

 * Refer to the implementations for different classes of problems:
 * 
 *     Parsing errors: {@link ConfigurationParsingException}
 *     Validation errors: {@link ConfigurationValidationException}
 * 
 */
public abstract class ConfigurationException extends Exception {
    /**
     * Auto-generated by Eclipse.
     */
    private static final long serialVersionUID = 7596147083618606385L;

    /**
     * A constant representing a newline sequence.
     */
    protected static final String NEWLINE = String.format("%n");

    /**
     * The configuration related errors.
     */
    private final Collection errors;

    /**
     * Creates a new ConfigurationException for the given path with the given errors.
     *
     * @param path      the bad configuration path
     * @param errors    the errors in the path
     */
    protected ConfigurationException(String path, Collection errors) {
        super(formatMessage(path, errors));
        this.errors = errors;
    }

    /**
     * Creates a new ConfigurationException for the given path with the given errors and cause.
     *
     * @param path      the bad configuration path
     * @param errors    the errors in the path
     * @param cause     the cause of the error(s)
     */
    protected ConfigurationException(String path, Collection errors, Throwable cause) {
        super(formatMessage(path, errors), cause);
        this.errors = errors;
    }

    /**
     * Returns the configuration errors.
     *
     * @return a collection of strings representing the configuration errors
     */
    public Collection getErrors() {
        return errors;
    }

    /**
     * Formats a message for the exception reporting the errors that occurred related to the configuration.
     *
     * @param file the configuration file
     * @param errors the configuration errors
     * @return the formatted message
     */
    protected static String formatMessage(String file, Collection errors) {
        final StringBuilder msg = new StringBuilder(file);
        msg.append(errors.size() == 1 ? " has an error:" : " has the following errors:").append(NEWLINE);
        for (String error : errors) {
            msg.append("  * ").append(error).append(NEWLINE);
        }
        return msg.toString();
    }
}