RegionBlockIterator.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


package com.jcwhatever.nucleus.regions;

import com.jcwhatever.nucleus.providers.regionselect.IRegionSelection;
import com.jcwhatever.nucleus.utils.PreCon;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.block.Block;

import javax.annotation.Nullable;
import java.util.Iterator;

/**
 * Iterates through all blocks in a region.
 */
public class RegionBlockIterator implements Iterator<Block> {

    private int _currentY;
    private int _currentX;
    private int _currentZ;
    private Block _current;

    private IRegionSelection _region;

    /**
     * Constructor.
     *
     * @param region  The region to iterate.
     */
    public RegionBlockIterator (IRegionSelection region) {
        PreCon.notNull(region);

        _region = region;

        _currentY = region.getYStart();
        _currentX = region.getXStart();
        _currentZ = region.getZStart();
    }

    /**
     * Constructor.
     *
     * @param p1  The first region coordinates.
     * @param p2  The second region coordinates.
     */
    public RegionBlockIterator (Location p1, Location p2) {
        this(new SimpleRegionSelection(p1, p2));
    }

    /**
     * Determine if there is a next block.
     */
    @Override
    public boolean hasNext() {
        if (!_region.isDefined())
            return false;

        if (_currentY > _region.getYEnd())
            return false;

        return true;
    }

    /**
     * Get the next block.
     */
    @Override
    @Nullable
    public Block next() {

        if (!hasNext())
            return null;

        //noinspection ConstantConditions
        _current = _region.getWorld().getBlockAt(_currentX, _currentY, _currentZ);

        _currentZ++;

        if (_currentZ > _region.getZEnd()) {
            _currentZ = _region.getZStart();
            _currentX++;

            if (_currentX > _region.getXEnd()) {
                _currentX = _region.getXStart();

                _currentY++;
            }
        }

        return _current;

    }

    /**
     * Remove the current block. Sets the block material to {@link Material#AIR}.
     */
    @Override
    public void remove() {
        if (_current != null)
            _current.setType(Material.AIR);
    }
}