com.anrisoftware.resources.api.ResourcesException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resources-api Show documentation
The public API of the resources project.
There is a newer version: 4.8.0
/*
 * Copyright 2012-2016 Erwin Müller 
 *
 * This file is part of resources-api.
 *
 * resources-api is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * resources-api is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with resources-api. If not, see .
 */
package com.anrisoftware.resources.api;

import static org.apache.commons.lang3.StringUtils.isEmpty;

import java.util.Map;
import java.util.MissingResourceException;

import com.anrisoftware.globalpom.exceptions.Context;

/**
 * Exception that is thrown if there was an error loading a resource.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
@SuppressWarnings("serial")
public class ResourcesException extends MissingResourceException {

    private final Context context;

    private final Throwable cause;

    /**
     * @see MissingResourceException#MissingResourceException(String, String,
     *      String)
     *
     * @since 1.7
     */
    public ResourcesException(String message, String className, String key) {
        this(null, message, className, key);
    }

    /**
     * @param cause
     *            the {@link Throwable} cause of the exception.
     *
     * @see MissingResourceException#MissingResourceException(String, String,
     *      String)
     *
     * @since 1.7
     */
    public ResourcesException(Throwable cause, String message,
            String className, String key) {
        super(message, className, key);
        this.context = new Context(this);
        this.cause = cause;
        if (cause != null) {
            addContext("cause", cause);
        }
        if (!isEmpty(key)) {
            addContext("key", key);
        }
        if (!isEmpty(className)) {
            addContext("class name", className);
        }
    }

    /**
     * Adds the context with the specified name.
     *
     * @param name
     *            the name of the context.
     *
     * @param value
     *            the context value.
     *
     * @return the context {@link Exception}.
     *
     * @since 1.7
     */
    public ResourcesException addContext(String name, Object value) {
        return context.addContext(name, value);
    }

    /**
     * Returns the context of the exception.
     *
     * @return an unmodifiable {@link Map} with the context.
     *
     * @since 1.7
     */
    public Map getContext() {
        return context.getContext();
    }

    @Override
    public synchronized Throwable getCause() {
        return (cause == this ? null : cause);
    }

    /**
     * Output the exception message and the context:
     *
     *      * Message of the exception, context:
     * Aaa := bbb
     * Ccc := ddd
     * 
     *
     * @since 1.7
     */
    @Override
    public String toString() {
        return context.toString();
    }
}