com.github.dandelion.core.DandelionException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dandelion-core Show documentation
Dandelion Core module providing all APIs and standard implementations.
There is a newer version: 1.1.1
/*
 * [The "BSD licence"]
 * Copyright (c) 2013 Dandelion
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Dandelion nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.dandelion.core;

import java.text.MessageFormat;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.ResourceBundle;

/**
 * Exception for Dandelion domain
 */
public class DandelionException extends RuntimeException {
    /**
     * Error Code of this Exception
     */
    private DandelionError errorCode;
    /**
     * Parameters of this Exception
     */
    private Map parameters = new LinkedHashMap();

    /**
     * @param errorCode Domain-Specific Error
     */
    public DandelionException(DandelionError errorCode) {
        super();
        this.errorCode = errorCode;
    }

    /**
     * Create the Bundle Key for a Dandelion Error
     * @param error Dandelion Error
     * @return a valid Bundle Key
     */
    public static String createBundleKey(DandelionError error) {
        return error.getClass().getSimpleName() + "__" + error.getNumber();
    }

    /**
     * Create a DandelionException to wrapped Exception
     * @param message message of wrapped exception
     * @param exception wrapped exception
     * @param errorCode associated error
     */
    private DandelionException(String message, Throwable exception, DandelionError errorCode) {
        super(message, exception);
        this.errorCode = errorCode;

    }

    /**
     * @return associated error to this exception
     */
    public DandelionError getErrorCode() {
        return errorCode;
    }

    /**
     * Add a relevant data (field/value) for this exception
     * @param field field of this relevant data
     * @param value value of this relevant data
     * @return this exception (for 'fluent interface' purpose)
     */
    public DandelionException set(String field, Object value) {
        parameters.put(field, value);
        return this;
    }

    /**
     * Get the value of stored data by his field
     * @param field field of stored data
     * @param  type of this value
     * @return the casted value
     */
    public  T get(String field) {
        return (T) parameters.get(field);
    }

    /**
     * Wrap a Exception into a DandelionException
     * @param exception exception to wrap
     * @param error associated dandelion error
     * @return generated exception
     */
    public static DandelionException wrap(Throwable exception, DandelionError error) {
        if (exception instanceof DandelionException) {
            DandelionException se = (DandelionException)exception;
            if (error != null && error != se.getErrorCode()) {
                return new DandelionException(exception.getMessage(), exception, error);
            }
            return se;
        } else {
            return new DandelionException(exception.getMessage(), exception, error);
        }
    }

    /**
     * @return the localized Message for Dandelion Error
     */
    @Override
    public String getLocalizedMessage() {
        if (errorCode == null) {
            return null;
        }
        String key = createBundleKey(errorCode);
        ResourceBundle bundle = ResourceBundle.getBundle("com.github.dandelion.core.api.exceptions");
        return MessageFormat.format(bundle.getString(key), parameters.values());
    }
}