com.dropbox.core.DbxApiException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropbox-core-sdk Show documentation

Official Java client library for the Dropbox API.

There is a newer version: 7.0.0

package com.dropbox.core;

/**
 * Base class for API-specific exceptions raised by API v2 routes.
 */
public class DbxApiException extends DbxException {
    private static final long serialVersionUID = 0L;

    private final LocalizedText userMessage;

    public DbxApiException(String requestId, LocalizedText userMessage, String message) {
        super(requestId, message);
        this.userMessage = userMessage;
    }

    public DbxApiException(String requestId, LocalizedText userMessage, String message, Throwable cause) {
        super(requestId, message, cause);
        this.userMessage = userMessage;
    }

    /**
     * Returns a human-readable message that can be displayed to the end user.
     *
     *  If no such message is available, then this method returns {@code null}.
     *
     * @return human-readable message to display to end user, or {@code null} if unavailable
     */
    public LocalizedText getUserMessage() {
        return userMessage;
    }

    protected static String buildMessage(String routeName, LocalizedText userMessage) {
        return buildMessage(routeName, userMessage, null);
    }

    protected static String buildMessage(String routeName, LocalizedText userMessage, Object errorValue) {
        StringBuilder sb = new StringBuilder();
        sb.append("Exception in ").append(routeName);
        if (errorValue != null) {
            sb.append(": ").append(errorValue);
        }
        if (userMessage != null) {
            sb.append(" (user message: ").append(userMessage).append(")");
        }
        return sb.toString();
    }
}