/*
 * 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;

import android.os.Parcel;
import android.os.Parcelable;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import com.scvngr.levelup.core.annotation.LevelUpApi;
import com.scvngr.levelup.core.annotation.LevelUpApi.Contract;
import com.scvngr.levelup.core.annotation.model.RequiredField;
import com.scvngr.levelup.core.util.NullUtils;

import net.jcip.annotations.Immutable;

import lombok.Value;

// The code below will be machine-processed.
// CHECKSTYLE:OFF

/**
 * Represents a credit of a {@link Location} on the server.
 */

@Immutable
@Value
@LevelUpApi(contract = Contract.DRAFT)
public final class LocationCredit implements Parcelable {

    /**
     * The amount of credit the merchant has credited.
     */
    @Nullable
    private final MonetaryValue merchantFundedCreditValue;

    /**
     * The total amount of credit.
     */
    @NonNull
    @RequiredField
    private final MonetaryValue totalAmountValue;

    /**
     * Implements the {@code Parcelable} interface.
     */
    @NonNull
    public static final Creator<LocationCredit> CREATOR = new LocationCreditCreator();

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(final Parcel dest, final int flags) {
        ((LocationCreditCreator) CREATOR).writeToParcel(NullUtils.nonNullContract(dest), flags,
                this);
    }

    @Immutable
    private static final class LocationCreditCreator implements Creator<LocationCredit> {

        @Override
        public LocationCredit[] newArray(final int size) {
            return new LocationCredit[size];
        }

        @Override
        public LocationCredit createFromParcel(final Parcel in) {
            final MonetaryValue merchantCreditValue =
                    in.readParcelable(MonetaryValue.class.getClassLoader());
            final MonetaryValue totalValue =
                    in.readParcelable(MonetaryValue.class.getClassLoader());

            return new LocationCredit(merchantCreditValue, NullUtils.nonNullContract(totalValue));
        }

        private void writeToParcel(@NonNull final Parcel dest, final int flags,
                @NonNull final LocationCredit locationCredit) {
            dest.writeParcelable(locationCredit.getMerchantFundedCreditValue(), flags);
            dest.writeParcelable(locationCredit.getTotalAmountValue(), flags);
        }
    }

    /**
     * @param merchantFundedCreditValue the available merchant credit
     * @param totalAmountValue the total credit available
     */
    public LocationCredit(@Nullable final MonetaryValue merchantFundedCreditValue,
            @NonNull final MonetaryValue totalAmountValue) {
        this.merchantFundedCreditValue = merchantFundedCreditValue;
        this.totalAmountValue = totalAmountValue;
    }
}