Claim.java

/*
 * 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.util.NullUtils;

import net.jcip.annotations.Immutable;

import lombok.AllArgsConstructor;
import lombok.Value;

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

/**
 * Represents a claim of a {@link Campaign} on the server.
 */
@Immutable
@AllArgsConstructor(suppressConstructorProperties = true)
@Value
@LevelUpApi(contract = Contract.DRAFT)
public final class Claim implements Parcelable {

    /**
     * The web service ID of the {@link com.scvngr.levelup.core.model.Campaign} that was claimed.
     */
    private final long campaignId;

    /**
     * The code of the {@link com.scvngr.levelup.core.model.Campaign} that was claimed.
     */
    @Nullable
    private final String code;

    /**
     * The web service ID of this {@link com.scvngr.levelup.core.model.Claim}.
     */
    private final long id;

    /**
     * The amount that this {@link com.scvngr.levelup.core.model.Claim} is worth.
     */
    @Nullable
    private final MonetaryValue value;

    /**
     * The amount that this {@link com.scvngr.levelup.core.model.Claim} still has remaining after
     * all redemptions.
     */
    @Nullable
    private final MonetaryValue valueRemaining;

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

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

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

    @Immutable
    private static final class ClaimCreator implements Creator<Claim> {

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

        @Override
        public Claim createFromParcel(final Parcel in) {
            final long campaignId = in.readLong();
            final String code = NullUtils.nonNullContract(in.readString());
            final long id = in.readLong();
            final MonetaryValue value = in.readParcelable(MonetaryValue.class.getClassLoader());
            final MonetaryValue valueRemaining =
                    in.readParcelable(MonetaryValue.class.getClassLoader());

            return new Claim(campaignId, code, id, value, valueRemaining);
        }

        private void writeToParcel(@NonNull final Parcel dest, final int flags,
                @NonNull final Claim claim) {
            dest.writeLong(claim.getCampaignId());
            dest.writeString(claim.getCode());
            dest.writeLong(claim.getId());
            dest.writeParcelable(claim.getValue(), flags);
            dest.writeParcelable(claim.getValueRemaining(), flags);
        }
    }
}