/*******************************************************************************
* Copyright (c) 2015
*
* 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 jsettlers.algorithms.interfaces;
import jsettlers.algorithms.traversing.borders.BorderTraversingAlgorithm;
/**
* This interface defines a method a contains(x,y) method needed by several algorithms (e.g. {@link BorderTraversingAlgorithm} ).
*
* @author Andreas Eberle
*
*/
public interface IContainingProvider {
/**
* This method defines the area the {@link BorderTraversingAlgorithm} is walking around.
*
* @param x
* X coordinate of the position.
* @param y
* Y coordinate of the position.
* @return true if the given position is in the area that shall be surrounded by the border.<br>
* false if the position is on the outside.
*/
boolean contains(int x, int y);
}