com.omertron.imdbapi.model.AbstractJsonMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-imdb Show documentation
API for the mobile JSON API of IMDB
There is a newer version: 1.5
package com.omertron.imdbapi.model;

import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.io.Serializable;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Abstract class to handle any unknown properties by outputting a log message
 *
 * @author stuart.boston
 */
public abstract class AbstractJsonMapping implements Serializable, IStatusMessage {

    private static final transient Logger LOG = LoggerFactory.getLogger(AbstractJsonMapping.class);

    @JsonProperty("error")
    private ImdbStatusMessage statusMessage = null;
    private boolean error = Boolean.FALSE;

    /**
     * Get the status message
     *
     * @return
     */
    @Override
    public ImdbStatusMessage getStatusMessage() {
        return statusMessage;
    }

    /**
     * Set the detailed status message for the error
     *
     * @param statusMessage
     */
    @Override
    public void setStatusMessage(ImdbStatusMessage statusMessage) {
        this.statusMessage = statusMessage;
        // Set the error flag
        this.error = Boolean.TRUE;
    }

    /**
     * Set the status message for the error
     *
     * @param message
     */
    @Override
    public void setStatusMessageMsg(String message) {
        setStatusMessage(new ImdbStatusMessage(message));
    }

    /**
     * Set the status message and exception for the error
     *
     * @param message
     * @param error
     */
    @Override
    public void setStatusMessage(String message, Throwable error) {
        ImdbStatusMessage sm = new ImdbStatusMessage(message);
        sm.setThrownError(error);
        setStatusMessage(sm);
    }

    /**
     * Does the result have an error?
     *
     * @return
     */
    @Override
    public boolean isError() {
        return error;
    }

    /**
     * Handle unknown properties and print a message
     *
     * @param key
     * @param value
     */
    @JsonAnySetter
    protected void handleUnknown(String key, Object value) {
        StringBuilder unknown = new StringBuilder(this.getClass().getSimpleName());
        unknown.append(": Unknown property='").append(key);
        unknown.append("' value='").append(value).append("'");

        LOG.trace(unknown.toString());
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE, Boolean.FALSE);
    }
}