<?php

/**
 * Fontis Australia Post API client library for PHP
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/osl-3.0.php
 *
 * @category   Fontis
 * @package    Fontis_Auspost
 * @copyright  Copyright (c) 2019 Fontis Pty. Ltd. (https://www.fontis.com.au)
 * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */
declare (strict_types=1);
namespace OctolizeShippingAustraliaPostVendor\Fontis\Auspost\Model\Postage;

use ArrayIterator;
use Countable;
use OctolizeShippingAustraliaPostVendor\Fontis\Auspost\Exception\EmptyCollection;
use IteratorAggregate;
use OutOfBoundsException;
use Traversable;
final class CountryCollection implements IteratorAggregate, Countable
{
    /**
     * @var Country[]
     */
    private $countries;
    /**
     * @param array $countries
     */
    public function __construct(array $countries = [])
    {
        $this->countries = array_values($countries);
    }
    /**
     * @return Traversable
     */
    public function getIterator()
    {
        return new ArrayIterator($this->countries);
    }
    /**
     * @return int
     */
    public function count(): int
    {
        return count($this->countries);
    }
    /**
     * @return bool
     */
    public function isEmpty(): bool
    {
        return empty($this->countries);
    }
    /**
     * @return Country
     * @throws EmptyCollection If the collection is empty.
     */
    public function first(): Country
    {
        if ($this->isEmpty()) {
            throw new EmptyCollection();
        }
        return reset($this->countries);
    }
    /**
     * @param int $index
     * @return Country
     * @throws OutOfBoundsException If the index param is not existed.
     */
    public function get(int $index): Country
    {
        if (!isset($this->countries[$index])) {
            throw new OutOfBoundsException(sprintf('The index "%s" does not exist in this collection.', $index));
        }
        return $this->countries[$index];
    }
}
