LeaderboardList.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.Iterator;
import java.util.List;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * List of leaderboards available in the game.
 */
@Data
@AllArgsConstructor(suppressConstructorProperties = true)
public class LeaderboardList implements Iterable<Leaderboard> {

    /** The number of leaderboards returned as part of this response. */
    private final int count;

    /**
     * The leaderboards themselves.
     *
     * Note: While each leaderboard's structure is the same as in an individual
     * leaderboard response, these leaderboards will not contain their entries.
     */
    private final List<Leaderboard> leaderboards;

    @Override
    public Iterator<Leaderboard> iterator() {
        return leaderboards.iterator();
    }

}