TurnList.java

/*
 * Copyright 2014-2015 GameUp
 *
 * 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 io.gameup.android.entity;

import java.util.List;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * Represents a list of turns in a turn-based multiplayer match on the GameUp
 * service. All of the turns belong to the same (requested) match.
 */
@Data
@AllArgsConstructor(suppressConstructorProperties = true)
public class TurnList {

    /** The match ID these turns belong to. */
    private final String matchId;

    /** The ordered list of turns. */
    private final List<Turn> turns;

    /** How many turns were returned in this list. */
    private final int count;

    /**
     * The total number of turns currently in the match, even if not all of
     * them were returned as part of this entity.
     */
    private final int turn;

}