/*
 * Copyright (C) 2014 SCVNGR, Inc. d/b/a LevelUp
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.scvngr.levelup.core.model.factory.json;

import android.support.annotation.NonNull;

import com.scvngr.levelup.core.annotation.JsonValueType;
import com.scvngr.levelup.core.annotation.JsonValueType.JsonType;
import com.scvngr.levelup.core.annotation.LevelUpApi;
import com.scvngr.levelup.core.annotation.LevelUpApi.Contract;
import com.scvngr.levelup.core.annotation.VisibleForTesting;
import com.scvngr.levelup.core.annotation.VisibleForTesting.Visibility;
import com.scvngr.levelup.core.model.Error;
import com.scvngr.levelup.core.model.util.JsonUtils;

import net.jcip.annotations.Immutable;

import org.json.JSONException;
import org.json.JSONObject;

/**
 * Class that creates {@link Error}s from JSON.
 */
@LevelUpApi(contract = Contract.DRAFT)
public final class ErrorJsonFactory extends AbstractJsonModelFactory<Error> {

    /**
     * Constructor.
     */
    public ErrorJsonFactory() {
        super(JsonKeys.MODEL_ROOT);
    }

    @Override
    @NonNull
    protected Error createFrom(@NonNull final JSONObject json) throws JSONException {
        final String code = JsonUtils.optString(json, JsonKeys.CODE);
        final String message = json.getString(JsonKeys.MESSAGE);
        final String object = JsonUtils.optString(json, JsonKeys.OBJECT);
        final String property = JsonUtils.optString(json, JsonKeys.PROPERTY);

        return new Error(code, message, object, property);
    }

    /**
     * All of the keys in the JSON representation of this model.
     */
    @VisibleForTesting(visibility = Visibility.PRIVATE)
    @Immutable
    public static final class JsonKeys {
        /**
         * The key under which this model can be nested.
         */
        @JsonValueType(JsonType.JSON_OBJECT)
        @NonNull
        public static final String MODEL_ROOT = "error";

        /**
         * The key in JSON where the error code can be parsed.
         */
        @JsonValueType(JsonType.STRING)
        @NonNull
        public static final String CODE = "code";

        /**
         * The key in JSON where the error message can be parsed.
         */
        @JsonValueType(JsonType.STRING)
        @NonNull
        public static final String MESSAGE = "message";

        /**
         * The key in JSON where the error object can be parsed.
         */
        @JsonValueType(JsonType.STRING)
        @NonNull
        public static final String OBJECT = "object";

        /**
         * The key in JSON where the error object property can be parsed.
         */
        @JsonValueType(JsonType.STRING)
        @NonNull
        public static final String PROPERTY = "property";

        /**
         * Private constructor prevents instantiation.
         *
         *
         * @throws UnsupportedOperationException because this class cannot be instantiated.
         */
        private JsonKeys() {
            throw new UnsupportedOperationException("This class is non-instantiable");
        }
    }
}