Map.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol.common.model |
 |
 |
FreeCol |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| COMMENTS | Comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| SIZE | Size of the file in bytes | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINES | Number of lines in the source file | |
| PARAMS | Number of formal parameter declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| RETURNS | Number of return points from functions | |
| COMPARISONS | Number of comparison operators | |
| BLOCKS | Number of blocks | |
| FUNCTIONS | Number of function declarations | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| LOOPS | Number of loops | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| EXEC_COMMENTS | Comments in executable code | |
| WHITESPACE | Number of whitespace lines | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| NEST_DEPTH | Maximum nesting depth | |
| LINE_COMMENT | Number of line comments | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0277 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0094 | JAVA0094 Field hides a superclass field | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**
* Copyright (C) 2002-2007 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.model;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.PriorityQueue;
import java.util.Random;
import java.util.logging.Logger;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import net.sf.freecol.common.PseudoRandom;
/**
* An isometric map. The map is represented as a collection of tiles.
*/
public class Map extends FreeColGameObject {
private static final Logger logger = Logger.getLogger(Map.class.getName());
/**
* The directions a Unit can move to. Includes deltas for moving
* to adjacent squares, which are required due to the isometric
* map. Starting north and going clockwise.
*/
public static enum Direction {
N ( 0, -2, 0, -2),
NE ( 1, -1, 0, -1),
E ( 1, 0, 1, 0),
SE ( 1, 1, 0, 1),
S ( 0, 2, 0, 2),
SW ( 0, 1, -1, 1),
W (-1, 0, -1, 0),
NW ( 0, -1, -1, -1);
private int oddDX, oddDY, evenDX, evenDY;
Direction(int oddDX, int oddDY, int evenDX, int evenDY) {
this.oddDX = oddDX;
this.oddDY = oddDY;
this.evenDX = evenDX;
this.evenDY = evenDY;
}
public int getOddDX() {
return oddDX;
}
public int getOddDY() {
return oddDY;
}
public int getEvenDX() {
return evenDX;
}
public int getEvenDY() {
return evenDY;
}
/**
* Returns the reverse direction of the given direction.
*
* @return The reverse direction of the given direction.
*/
public Direction getReverseDirection() {
switch (this) {
case N:
return S;
case NE:
return SW;
case E:
return W;
case SE:
return NW;
case S:
return N;
case SW:
return NE;
case W:
return E;
case NW:
return SE;
default:
return null;
}
}
}
public static final int NUMBER_OF_DIRECTIONS = Direction.values().length;
/** The infinity cost as used by {@link #findPath(Unit, Tile, Tile)}. */
public static final int COST_INFINITY = Integer.MAX_VALUE - 100000000;
/** Constant used for given options in {@link #findPath(Unit, Tile, Tile)}. */
public static enum PathType { BOTH_LAND_AND_SEA, ONLY_LAND, ONLY_SEA }
private Tile[][] tiles;
private final DefaultCostDecider defaultCostDecider = new DefaultCostDecider();
private final java.util.Map<String, Region> regions = new HashMap<String, Region>();
/**
* Create a new <code>Map</code> from a collection of tiles.
*
* @param game
* The <code>Game</code> this map belongs to.
* @param tiles
* The 2D array of tiles.
*/
public Map(Game game, Tile[][] tiles) {
super(game);
this.tiles = tiles;
}
/**
* Create a new <code>Map</code> from an <code>Element</code> in a
* DOM-parsed XML-tree.
*
* @param game
* The <code>Game</code> this map belongs to.
* @param in
* The input stream containing the XML.
* @throws XMLStreamException
* if a problem was encountered during parsing.
*/
public Map(Game game, XMLStreamReader in) throws XMLStreamException {
super(game, in);
readFromXML(in);
}
/**
* Initiates a new <code>Map</code> with the given ID. The object should
* later be initialized by calling either
* {@link #readFromXML(XMLStreamReader)} or
* {@link #readFromXMLElement(Element)}.
*
* @param game
* The <code>Game</code> in which this object belong.
* @param id
* The unique identifier for this object.
*/
public Map(Game game, String id) {
super(game, id);
}
public Collection<Region> getRegions() {
return regions.values();
}
/**
* Returns the <code>Region</code> with the given ID.
*
* @param id a <code>String</code> value
* @return a <code>Region</code> value
*/
public Region getRegion(final String id) {
return regions.get(id);
}
/**
* Returns the <code>Region</code> with the given name.
*
* @param id a <code>String</code> value
* @return a <code>Region</code> value
*/
public Region getRegionByName(final String id) {
for (Region region : regions.values()) {
if (id.equals(region.getName())) {
return region;
}
}
return null;
}
/**
* Describe <code>setRegion</code> method here.
*
* @param region a <code>Region</code> value
*/
public void setRegion(final Region region) {
regions.put(region.getNameKey(), region);
}
/**
* Finds a shortest path between the given tiles. The <code>Tile</code> at
* the <code>end</code> will not be checked against the
* <code>options</code>.
*
* <br>
* <br>
*
* <i>Important: This method will not include colonies in a possible path,
* and {@link PathNode#getTurns}, {@link PathNode#getTotalTurns} and
* {@link PathNode#getMovesLeft} will all return <code>-1</code> for the
* generated {@link PathNode}s.
*
* <br>
* <br>
*
* Use {@link #findPath(Unit, Tile, Tile)} whenever possible.</i>
*
* @param start
* The <code>Tile</code> in which the path starts from.
* @param end
* The end of the path.
* @param type
* One of: {@link PathType#BOTH_LAND_AND_SEA},
* {@link PathType#BOTH_LAND_AND_SEA}, {@link PathType#ONLY_LAND} and
* {@link PathType#ONLY_SEA}.
* @return A <code>PathNode</code> for the first tile in the path. Calling
* {@link PathNode#getTile} on this object, will return the
* <code>Tile</code> right after the specified starting tile, and
* {@link PathNode#getDirection} will return the direction you need
* to take in order to reach that tile. This method returns
* <code>null</code> if no path is found.
* @see #findPath(Unit, Tile, Tile)
* @see Unit#findPath(Tile)
* @exception IllegalArgumentException
* if either <code>start</code> or <code>end</code> are
* <code>null</code>.
*/
public PathNode findPath(Tile start, Tile end, PathType type) {
return findPath(null, start, end, type);
}
/**
* Finds a shortest path between the given tiles. The <code>Tile</code> at
* the <code>end</code> will not be checked against the <code>unit</code>'s
* legal moves.
*
* @param unit
* The <code>Unit</code> that should be used to determine
* whether or not a path is legal.
* @param start
* The <code>Tile</code> in which the path starts from.
* @param end
* The end of the path.
* @return A <code>PathNode</code> for the first tile in the path. Calling
* {@link PathNode#getTile} on this object, will return the
* <code>Tile</code> right after the specified starting tile, and
* {@link PathNode#getDirection} will return the direction you need
* to take in order to reach that tile. This method returns
* <code>null</code> if no path is found.
* @see #findPath(Tile, Tile, PathType)
* @see Unit#findPath(Tile)
* @exception IllegalArgumentException
* if either <code>unit</code>, <code>start</code> or
* <code>end</code> are <code>null</code>.
*/
public PathNode findPath(Unit unit, Tile start, Tile end) {
if (unit == null) {
throw new IllegalArgumentException("Unit must not be 'null'.");
}
return findPath(unit, start, end, null, null);
}
/**
* Finds a shortest path between the given tiles. The <code>Tile</code> at
* the <code>end</code> will not be checked against the <code>unit</code>'s
* legal moves.
*
* @param unit
* The <code>Unit</code> that should be used to determine
* whether or not a path is legal.
* @param start
* The <code>Tile</code> in which the path starts from.
* @param end
* The end of the path.
* @param carrier
* A carrier that currently holds the <code>unit</code>, or
* <code>null</code> if the <code>unit</code> is not
* presently on a carrier.
* @return A <code>PathNode</code> for the first tile in the path. Calling
* {@link PathNode#getTile} on this object, will return the
* <code>Tile</code> right after the specified starting tile, and
* {@link PathNode#getDirection} will return the direction you need
* to take in order to reach that tile. This method returns
* <code>null</code> if no path is found.
* @see #findPath(Tile, Tile, PathType)
* @see Unit#findPath(Tile)
* @exception IllegalArgumentException
* if either <code>unit</code>, <code>start</code> or
* <code>end</code> are <code>null</code>.
*/
public PathNode findPath(Unit unit, Tile start, Tile end, Unit carrier) {
if (unit == null) {
throw new IllegalArgumentException("Unit must not be 'null'.");
}
return findPath(unit, start, end, null, carrier);
}
/**
* Finds a shortest path between the given tiles. The <code>Tile</code> at
* the <code>end</code> will not be checked against validity (neither the
* <code>options</code> nor allowed movement by the <code>unit</code>.
*
* @param unit
* The <code>Unit</code> that should be used to determine
* whether or not a path is legal. The <code>options</code> are
* used instead if <code>unit == null</code>.
* @param start
* The <code>Tile</code> in which the path starts from.
* @param end
* The end of the path.
* @param type
* One of: {@link PathType#BOTH_LAND_AND_SEA},
* {@link PathType#BOTH_LAND_AND_SEA}, {@link PathType#ONLY_LAND} and
* {@link PathType#ONLY_SEA}. This argument if ignored if
* <code>unit != null</code>.
* @return A <code>PathNode</code> for the first tile in the path. Calling
* {@link PathNode#getTile} on this object, will return the
* <code>Tile</code> right after the specified starting tile, and
* {@link PathNode#getDirection} will return the direction you need
* to take in order to reach that tile. This method returns
* <code>null</code> if no path is found.
* @exception IllegalArgumentException
* if either <code>start</code> or <code>end</code> are
* <code>null</code>.
* @exception IllegalArgumentException
* if <code>start == end</code>.
*/
private PathNode findPath(Unit unit, Tile start, Tile end, PathType type) {
return findPath(unit, start, end, type, null);
}
/**
* Finds a shortest path between the given tiles. The <code>Tile</code> at
* the <code>end</code> will not be checked against validity (neither the
* <code>options</code> nor allowed movement by the <code>unit</code>.
*
* @param unit
* The <code>Unit</code> that should be used to determine
* whether or not a path is legal. The <code>options</code> are
* used instead if <code>unit == null</code>.
* @param start
* The <code>Tile</code> in which the path starts from.
* @param end
* The end of the path.
* @param type
* One of: {@link PathType#BOTH_LAND_AND_SEA},
* {@link PathType#BOTH_LAND_AND_SEA}, {@link PathType#ONLY_LAND} and
* {@link PathType#ONLY_SEA}. This argument if ignored if
* <code>unit != null</code>.
* @param carrier
* A carrier that currently holds the <code>unit</code>, or
* <code>null</code> if the <code>unit</code> is not
* presently on a carrier.
* @return A <code>PathNode</code> for the first tile in the path. Calling
* {@link PathNode#getTile} on this object, will return the
* <code>Tile</code> right after the specified starting tile, and
* {@link PathNode#getDirection} will return the direction you need
* to take in order to reach that tile. This method returns
* <code>null</code> if no path is found.
* @exception IllegalArgumentException
* if either <code>start</code> or <code>end</code> are
* <code>null</code>.
* @exception IllegalArgumentException
* if <code>start == end</code>.
*/
private PathNode findPath(Unit unit, Tile start, final Tile end, PathType type,
Unit carrier) {
/*
* Using A* with the Manhatten distance as the heuristics.
*
* The data structure for the open list is a combined structure: using a
* HashMap for membership tests and a PriorityQueue for getting the node
* with the minimal f (cost+heuristics). This gives O(1) on membership
* test and O(log N) for remove-best and insertions.
*
* The data structure for the closed list is simply a HashMap.
*/
if (start == null) {
throw new IllegalArgumentException("Argument 'start' must not be 'null'.");
}
if (end == null) {
throw new IllegalArgumentException("Argument 'end' must not be 'null'.");
}
if (start.equals(end)) {
throw new IllegalArgumentException("start == end");
}
if (carrier != null && unit == null) {
throw new IllegalArgumentException("Argument 'unit' must not be 'null'.");
}
final Unit theUnit = unit;
if (carrier != null) {
unit = carrier;
}
PathNode firstNode;
if (unit != null) {
firstNode = new PathNode(start, 0, getDistance(start.getPosition(),
end.getPosition()), Direction.N, unit.getMovesLeft(), 0);
firstNode.setOnCarrier(carrier != null);
} else {
firstNode = new PathNode(start, 0, getDistance(start.getPosition(),
end.getPosition()), Direction.N, -1, -1);
}
final HashMap<String, PathNode> openList = new HashMap<String, PathNode>();
final PriorityQueue<PathNode> openListQueue = new PriorityQueue<PathNode>(
1024, new Comparator<PathNode>() {
public int compare(PathNode o, PathNode p) {
int i = o.getF() - p.getF();
if (i != 0) {
return i;
} else {
i = o.getTile().getX() - p.getTile().getX();
if (i != 0) {
return i;
} else {
return o.getTile().getY() - p.getTile().getY();
}
}
}
});
final HashMap<String, PathNode> closedList = new HashMap<String, PathNode>();
openList.put(firstNode.getTile().getId(), firstNode);
openListQueue.offer(firstNode);
while (!openList.isEmpty()) {
// Choosing the node with the lowest f:
PathNode currentNode = openListQueue.peek();
// Found our goal:
if (currentNode.getTile() == end) {
while (currentNode.previous != null) {
currentNode.previous.next = currentNode;
currentNode = currentNode.previous;
}
return currentNode.next;
}
// Try every direction:
for (Direction direction : Direction.values()) {
Tile newTile = getNeighbourOrNull(direction, currentNode.getTile());
if (newTile == null) {
continue;
}
int cost = currentNode.getCost();
int movesLeft = currentNode.getMovesLeft();
int turns = currentNode.getTurns();
boolean onCarrier = currentNode.isOnCarrier();
// Check for disembark:
if (carrier != null
&& onCarrier
&& newTile.isLand()
&& (newTile.getSettlement() == null || newTile
.getSettlement().getOwner() == unit.getOwner())) {
onCarrier = false;
unit = theUnit;
movesLeft = unit.getInitialMovesLeft();
} else {
if (currentNode.isOnCarrier()) {
unit = carrier;
} else {
unit = theUnit;
}
}
if (unit != null) {
int extraCost = defaultCostDecider.getCost(unit,
currentNode.getTile(), newTile, movesLeft, turns);
if (extraCost == CostDecider.ILLEGAL_MOVE && !newTile.equals(end)) {
continue;
}
if (extraCost == CostDecider.ILLEGAL_MOVE) {
if (newTile.equals(end)) {
cost += unit.getInitialMovesLeft();
movesLeft = 0;
}
} else {
if (carrier != null) {
if (unit.equals(carrier)) {
extraCost *= theUnit.getInitialMovesLeft();
} else {
extraCost *= carrier.getInitialMovesLeft();
}
}
cost += extraCost;
movesLeft = defaultCostDecider.getMovesLeft();
if (defaultCostDecider.isNewTurn()) {
turns++;
}
}
} else {
if ((type == PathType.ONLY_SEA && newTile.isLand() ||
type == PathType.ONLY_LAND && !newTile.isLand()) &&
!newTile.equals(end)) {
continue;
} else {
cost += newTile.getMoveCost(currentNode.getTile());
}
}
int f = cost
+ getDistance(newTile.getPosition(), end.getPosition());
// Finding the node on the open list:
PathNode successor = openList.get(newTile.getId());
if (successor != null) {
if (successor.getF() <= f) {
continue;
} else {
openList.remove(successor.getTile().getId());
openListQueue.remove(successor);
}
} else {
// Finding the node on the closed list.
successor = closedList.get(newTile.getId());
if (successor != null) {
if (successor.getF() <= f) {
continue;
} else {
closedList.remove(newTile.getId());
}
}
}
successor = new PathNode(newTile, cost, f, direction,
movesLeft, turns);
successor.previous = currentNode;
successor.setOnCarrier(onCarrier);
// Adding the new node to the open list:
openList.put(successor.getTile().getId(), successor);
openListQueue.offer(successor);
}
closedList.put(currentNode.getTile().getId(), currentNode);
// Removing the current node from the open list:
openList.remove(currentNode.getTile().getId());
openListQueue.remove(currentNode);
}
return null;
}
/**
* Finds a path to a goal determined by the given <code>GoalDecider</code>.
*
* <br />
* <br />
*
* A <code>GoalDecider</code> is typically defined inline to serve a
* specific need.
*
* @param unit
* The <code>Unit</code> to find the path for.
* @param gd
* The object responsible for determining wether a given
* <code>PathNode</code> is a goal or not.
* @param maxTurns
* The maximum number of turns the given <code>Unit</code> is
* allowed to move. This is the maximum search range for a goal.
* @return The path to a goal determined by the given
* <code>GoalDecider</code>.
*/
public PathNode search(Unit unit, GoalDecider gd, int maxTurns) {
return search(unit, unit.getTile(), gd, defaultCostDecider, maxTurns);
}
/**
* Finds a path to a goal determined by the given <code>GoalDecider</code>.
*
* <br />
* <br />
*
* A <code>GoalDecider</code> is typically defined inline to serve a
* specific need.
*
* @param unit
* The <code>Unit</code> to find the path for.
* @param startTile
* The <code>Tile</code> to start the search from.
* @param gd
* The object responsible for determining wether a given
* <code>PathNode</code> is a goal or not.
* @param maxTurns
* The maximum number of turns the given <code>Unit</code> is
* allowed to move. This is the maximum search range for a goal.
* @return The path to a goal determined by the given
* <code>GoalDecider</code>.
*/
public PathNode search(Unit unit, Tile startTile, GoalDecider gd,
int maxTurns) {
return search(unit, startTile, gd, defaultCostDecider, maxTurns);
}
/**
* Finds a path to a goal determined by the given <code>GoalDecider</code>.
*
* <br />
* <br />
*
* A <code>GoalDecider</code> is typically defined inline to serve a
* specific need.
*
* @param unit
* The <code>Unit</code> to find the path for.
* @param gd
* The object responsible for determining wether a given
* <code>PathNode</code> is a goal or not.
* @param maxTurns
* The maximum number of turns the given <code>Unit</code> is
* allowed to move. This is the maximum search range for a goal.
* @param carrier
* The carrier the <code>unit</code> is currently onboard or
* <code>null</code> if the <code>unit</code> is either not
* onboard a carrier or should not use the carrier while finding
* the path.
* @return The path to a goal determined by the given
* <code>GoalDecider</code>.
*/
public PathNode search(Unit unit, GoalDecider gd,
int maxTurns, Unit carrier) {
return search(unit, unit.getTile(), gd, defaultCostDecider, maxTurns, carrier);
}
/**
* Finds a path to a goal determined by the given <code>GoalDecider</code>.
*
* <br />
* <br />
*
* A <code>GoalDecider</code> is typically defined inline to serve a
* specific need.
*
* @param startTile
* The <code>Tile</code> to start the search from.
* @param gd
* The object responsible for determining wether a given
* <code>PathNode</code> is a goal or not.
* @param costDecider
* The object responsible for determining the cost.
* @param maxTurns
* The maximum number of turns the given <code>Unit</code> is
* allowed to move. This is the maximum search range for a goal.
* @return The path to a goal determined by the given
* <code>GoalDecider</code>.
*/
public PathNode search(Tile startTile, GoalDecider gd,
CostDecider costDecider, int maxTurns) {
return search(null, startTile, gd, costDecider, maxTurns);
}
/**
* Finds a path to a goal determined by the given <code>GoalDecider</code>.
*
* <br />
* <br />
*
* A <code>GoalDecider</code> is typically defined inline to serve a
* specific need.
*
* @param unit
* The <code>Unit</code> to find the path for.
* @param startTile
* The <code>Tile</code> to start the search from.
* @param gd
* The object responsible for determining wether a given
* <code>PathNode</code> is a goal or not.
* @param costDecider
* The object responsible for determining the cost.
* @param maxTurns
* The maximum number of turns the given <code>Unit</code> is
* allowed to move. This is the maximum search range for a goal.
* @return The path to a goal determined by the given
* <code>GoalDecider</code>.
*/
public PathNode search(Unit unit, Tile startTile, GoalDecider gd,
CostDecider costDecider, int maxTurns) {
return search(unit, startTile, gd, costDecider, maxTurns, null);
}
/**
* Finds a path to a goal determined by the given <code>GoalDecider</code>.
*
* <br />
* <br />
*
* A <code>GoalDecider</code> is typically defined inline to serve a
* specific need.
*
* @param unit
* The <code>Unit</code> to find the path for.
* @param startTile
* The <code>Tile</code> to start the search from.
* @param gd
* The object responsible for determining wether a given
* <code>PathNode</code> is a goal or not.
* @param costDecider
* The object responsible for determining the cost.
* @param maxTurns
* The maximum number of turns the given <code>Unit</code> is
* allowed to move. This is the maximum search range for a goal.
* @param carrier
* The carrier the <code>unit</code> is currently onboard or
* <code>null</code> if the <code>unit</code> is either not
* onboard a carrier or should not use the carrier while finding
* the path.
* @return The path to a goal determined by the given
* <code>GoalDecider</code>.
*/
public PathNode search(Unit unit, Tile startTile, GoalDecider gd,
CostDecider costDecider, int maxTurns, Unit carrier) {
/*
* Using Dijkstra's algorithm with a closedList for marking the visited
* nodes and using a PriorityQueue for getting the next edge with the
* least cost. This implementation could be improved by having the
* visited attribute stored on each Tile in order to avoid both of the
* HashMaps currently being used to serve this purpose.
*/
if (startTile == null) {
throw new IllegalArgumentException("startTile must not be 'null'.");
}
Unit theUnit = unit;
if (carrier != null) {
unit = carrier;
}
int ml = (unit != null) ? unit.getMovesLeft() : -1;
PathNode firstNode = new PathNode(startTile, 0, 0, Direction.N, ml, 0);
firstNode.setOnCarrier(carrier != null);
final HashMap<String, PathNode> openList = new HashMap<String, PathNode>();
final PriorityQueue<PathNode> openListQueue = new PriorityQueue<PathNode>(
1024, new Comparator<PathNode>() {
public int compare(PathNode o, PathNode p) {
int i = o.getCost() - p.getCost();
if (i != 0) {
return i;
} else {
i = o.getTile().getX() - p.getTile().getX();
if (i != 0) {
return i;
} else {
return o.getTile().getY() - p.getTile().getY();
}
}
}
});
final HashMap<String, PathNode> closedList = new HashMap<String, PathNode>();
openList.put(startTile.getId(), firstNode);
openListQueue.offer(firstNode);
while (!openList.isEmpty()) {
// Choosing the node with the lowest cost:
PathNode currentNode = openListQueue.poll();
openList.remove(currentNode.getTile().getId());
closedList.put(currentNode.getTile().getId(), currentNode);
// Reached the end
if (currentNode.getTurns() > maxTurns) {
break;
}
if (gd.check(unit, currentNode) && !gd.hasSubGoals()) {
PathNode bestTarget = gd.getGoal();
if (bestTarget != null) {
while (bestTarget.previous != null) {
bestTarget.previous.next = bestTarget;
bestTarget = bestTarget.previous;
}
return bestTarget.next;
} else {
logger.warning("The returned goal is null.");
return null;
}
}
// Try every direction:
for (Direction direction : Direction.values()) {
Tile newTile = getNeighbourOrNull(direction, currentNode
.getTile());
if (newTile == null) {
continue;
}
int cost = currentNode.getCost();
int movesLeft = currentNode.getMovesLeft();
int turns = currentNode.getTurns();
boolean onCarrier = currentNode.isOnCarrier();
// Check for disembark:
if (carrier != null
&& onCarrier
&& newTile.isLand()
&& (newTile.getSettlement() == null || newTile
.getSettlement().getOwner() == unit.getOwner())) {
onCarrier = false;
unit = theUnit;
movesLeft = unit.getInitialMovesLeft();
} else {
if (currentNode.isOnCarrier()) {
unit = carrier;
} else {
unit = theUnit;
}
}
int extraCost = costDecider.getCost(unit,
currentNode.getTile(), newTile, movesLeft, turns);
if (extraCost == CostDecider.ILLEGAL_MOVE) {
continue;
}
if (carrier != null && unit.equals(theUnit)) {
cost += extraCost
* (1 + (carrier.getInitialMovesLeft() / ((double) theUnit
.getInitialMovesLeft())));
} else {
cost += extraCost;
}
movesLeft = costDecider.getMovesLeft();
if (costDecider.isNewTurn()) {
turns++;
}
// Finding the node on the open list:
PathNode successor = closedList.get(newTile.getId());
if (successor != null) {
if (successor.getCost() <= cost) {
continue;
} else {
logger.warning("This should not happen. :-(");
}
} else {
successor = openList.get(newTile.getId());
if (successor != null) {
if (successor.getCost() <= cost) {
continue;
} else {
openList.remove(successor.getTile().getId());
openListQueue.remove(successor);
}
}
successor = new PathNode(newTile, cost, cost, direction,
movesLeft, turns);
successor.previous = currentNode;
successor.setOnCarrier(onCarrier);
openList.put(successor.getTile().getId(), successor);
openListQueue.offer(successor);
}
}
}
PathNode bestTarget = gd.getGoal();
if (bestTarget != null) {
while (bestTarget.previous != null) {
bestTarget.previous.next = bestTarget;
bestTarget = bestTarget.previous;
}
return bestTarget.next;
} else {
return null;
}
}
/**
* Gets the default <code>CostDecider</code>.
*
* @return The default <code>CostDecider</code>. This is currently a
* singleton instance of {@link DefaultCostDecider}.
*/
public CostDecider getDefaultCostDecider() {
return defaultCostDecider;
}
/**
* Checks if the given <code>Tile</code> is adjacent to the edge of the
* map.
*
* @param tile
* The <code>Tile</code> to be checked.
* @return <code>true</code> if the given tile is at the edge of the map.
*/
public boolean isAdjacentToMapEdge(Tile tile) {
for (Direction direction : Direction.values()) {
if (getNeighbourOrNull(direction, tile) == null) {
return true;
}
}
return false;
}
/**
* Finds the best path to <code>Europe</code>.
*
* @param unit
* The <code>Unit</code> that should be used to determine
* wether or not a path is legal.
* @param start
* The starting <code>Tile</code>.
* @return The path to the target or <code>null</code> if no target can be
* found.
* @see Europe
*/
public PathNode findPathToEurope(Unit unit, Tile start) {
GoalDecider gd = new GoalDecider() {
private PathNode goal = null;
public PathNode getGoal() {
return goal;
}
public boolean hasSubGoals() {
return false;
}
public boolean check(Unit u, PathNode pathNode) {
Map map = u.getGame().getMap();
if (pathNode.getTile().getType().canSailToEurope()) {
goal = pathNode;
return true;
}
if (map.isAdjacentToMapEdge(pathNode.getTile())) {
goal = pathNode;
return true;
}
return false;
}
};
return search(unit, start, gd, defaultCostDecider, Integer.MAX_VALUE);
}
/**
* Searches for land within the given radius.
*
* @param x
* X-component of the position to search from.
* @param y
* Y-component of the position to search from.
* @param distance
* The radius that should be searched for land, given in number
* of {@link Tile tiles}.
* @return <code>true</code> if there is {@link Tile#isLand land} within
* the given radius and <code>false</code> otherwise.
*/
public boolean isLandWithinDistance(int x, int y, int distance) {
Iterator<Position> i = getCircleIterator(new Position(x, y), true,
distance);
while (i.hasNext()) {
if (getTile(i.next()).isLand()) {
return true;
}
}
return false;
}
/**
* Returns the Tile at a requested position.
*
* @param p
* The position.
* @return The Tile at the given position.
*/
public Tile getTile(Position p) {
return getTile(p.getX(), p.getY());
}
/**
* Returns the Tile at position (x, y). 'x' specifies a column and 'y'
* specifies a row. (0, 0) is the Tile at the top-left corner of the Map.
*
* @param x
* The x-coordinate of the <code>Tile</code>.
* @param y
* The y-coordinate of the <code>Tile</code>.
* @return The Tile at position (x, y) or <code>null</code> if the
* position is invalid.
*/
public Tile getTile(int x, int y) {
if (isValid(x, y)) {
return tiles[x][y];
} else {
return null;
}
}
/**
* Sets the given tile the the given coordinates.
*
* @param x
* The x-coordinate of the <code>Tile</code>.
* @param y
* The y-coordinate of the <code>Tile</code>.
* @param tile
* The <code>Tile</code>.
*/
public void setTile(Tile tile, int x, int y) {
tiles[x][y] = tile;
}
/**
* Returns the width of this Map.
*
* @return The width of this Map.
*/
public int getWidth() {
if (tiles == null) {
return 0;
} else {
return tiles.length;
}
}
/**
* Returns the height of this Map.
*
* @return The height of this Map.
*/
public int getHeight() {
if (tiles == null) {
return 0;
} else {
return tiles[0].length;
}
}
/**
* Returns the neighbouring Tile of the given Tile in the given direction.
*
* @param direction
* The direction in which the neighbour is located given t.
* @param t
* The Tile to get a neighbour of.
* @return The neighbouring Tile of the given Tile in the given direction.
*/
public Tile getNeighbourOrNull(Direction direction, Tile t) {
return getNeighbourOrNull(direction, t.getX(), t.getY());
}
/**
* Returns the neighbouring Tile of the given Tile in the given direction.
*
* @param direction
* The direction in which the neighbour is located given the base
* tile.
* @param x
* The base tile X coordinate.
* @param y
* The base tile Y coordinate.
* @return The neighbouring Tile of the given coordinate in the given
* direction or null if invalid.
*/
public Tile getNeighbourOrNull(Direction direction, int x, int y) {
if (isValid(x, y)) {
Position pos = getAdjacent(new Position(x, y), direction);
return getTile(pos.getX(), pos.getY());
} else {
return null;
}
}
/**
* Returns all the tiles surrounding the given tile within the
* given range. The center tile itself is not included.
*
* @param t
* The tile that lies on the center of the tiles to return.
* @param range
* How far away do we need to go starting from the center tile.
* @return The tiles surrounding the given tile.
*/
public List<Tile> getSurroundingTiles(Tile t, int range) {
List<Tile> result = new ArrayList<Tile>();
Position tilePosition = new Position(t.getX(), t.getY());
Iterator<Position> i = (range == 1) ? getAdjacentIterator(tilePosition)
: getCircleIterator(tilePosition, true, range);
while (i.hasNext()) {
Position p = i.next();
if (!p.equals(tilePosition)) {
result.add(getTile(p));
}
}
return result;
}
/**
* Returns a random Direction.
*
* @return a <code>Direction</code> value
*/
public Direction getRandomDirection() {
int random = getGame().getModelController().getPseudoRandom().nextInt(NUMBER_OF_DIRECTIONS);
return Direction.values()[random];
}
/**
* Creates an array of the eight directions in a random order.
*
* @return The array.
*/
public Direction[] getRandomDirectionArray() {
Direction[] directions = Direction.values();
PseudoRandom random = getGame().getModelController().getPseudoRandom();
for (int i = 0; i < directions.length; i++) {
int i2 = random.nextInt(NUMBER_OF_DIRECTIONS);
if (i2 != i) {
Direction temp = directions[i2];
directions[i2] = directions[i];
directions[i] = temp;
}
}
return directions;
}
/**
* Gets an <code>Iterator</code> of every <code>Tile</code> on the map.
*
* @return the <code>Iterator</code>.
*/
public WholeMapIterator getWholeMapIterator() {
return new WholeMapIterator();
}
/**
* Gets the position adjacent to a given position, in a given
* direction.
*
* @param position The position
* @param direction The direction (N, NE, E, etc.)
* @return Adjacent position
*/
public static Position getAdjacent(Position position, Direction direction) {
int x = position.x + ((position.y & 1) != 0 ?
direction.getOddDX() : direction.getEvenDX());
int y = position.y + ((position.y & 1) != 0 ?
direction.getOddDY() : direction.getEvenDY());
return new Position(x, y);
}
/**
* Get an adjacent iterator.
*
* @param centerPosition
* The center position to iterate around
* @return Iterator
*/
public Iterator<Position> getAdjacentIterator(Position centerPosition) {
return new AdjacentIterator(centerPosition);
}
/**
* Get a border adjacent iterator.
*
* @param centerPosition
* The center position to iterate around
* @return Iterator
*/
public Iterator<Position> getBorderAdjacentIterator(Position centerPosition) {
return new BorderAdjacentIterator(centerPosition);
}
/**
* Get a flood fill iterator.
*
* @param centerPosition
* The center position to iterate around
* @return Iterator
*/
public Iterator<Position> getFloodFillIterator(Position centerPosition) {
return new CircleIterator(centerPosition, true, Integer.MAX_VALUE);
}
/**
* Get a circle iterator.
*
* @param center
* The center position to iterate around
* @param isFilled
* True to get all of the positions in the circle
* @param radius
* Radius of circle
* @return Iterator
*/
public CircleIterator getCircleIterator(Position center, boolean isFilled,
int radius) {
return new CircleIterator(center, isFilled, radius);
}
/**
* Checks whether a position is valid (within the map limits).
*
* @param position
* The position
* @return True if it is valid
*/
public boolean isValid(Position position) {
return isValid(position.x, position.y, getWidth(), getHeight());
}
/**
* Checks whether a position is valid (within the map limits).
*
* @param x
* X coordinate
* @param y
* Y coordinate
* @return True if it is valid
*/
public boolean isValid(int x, int y) {
return isValid(x, y, getWidth(), getHeight());
}
/**
* Checks whether a position is valid.
*
* @param position The position
* @param width The width of the map.
* @param height The height of the map.
* @return <code>true</code> if the given position is
* within the bounds of the map and <code>false</code> otherwise
*/
public static boolean isValid(Position position, int width, int height) {
return isValid(position.x, position.y, width, height);
}
/**
* Checks if the given position is valid.
*
* @param x The x-coordinate of the position.
* @param y The y-coordinate of the position.
* @param width The width of the map.
* @param height The height of the map.
* @return <code>true</code> if the given position is
* within the bounds of the map and <code>false</code> otherwise
*/
public static boolean isValid(int x, int y, int width, int height) {
return x >= 0 && x < width && y >= 0 && y < height;
}
/**
* Select a random land position on the map.
*
* <b>Warning:</b> This method should not be used by any model
* object unless we have completed restructuring the model
* (making all model changes at the server). The reason is
* the use of random numbers in this method.
*
* @return Position selected
*/
public Position getRandomLandPosition() {
PseudoRandom random = getGame().getModelController().getPseudoRandom();
int x = (getWidth() > 10) ? random.nextInt(getWidth() - 10) + 5 : random.nextInt(getWidth());
int y = (getHeight() > 10) ? random.nextInt(getHeight() - 10) + 5 : random.nextInt(getHeight());
Position centerPosition = new Position(x, y);
Iterator<Position> it = getFloodFillIterator(centerPosition);
while (it.hasNext()) {
Position p = it.next();
if (getTile(p).isLand()) {
return p;
}
}
return null;
}
/**
* Gets the distance in tiles between two map positions. With an isometric
* map this is a non-trivial task. The formula below has been developed
* largely through trial and error. It should cover all cases, but I
* wouldn't bet my life on it.
*
* @param position1
* The first position.
* @param position2
* The second position.
* @return Distance
*/
public int getDistance(Position position1, Position position2) {
return getDistance(position1.getX(), position1.getY(),
position2.getX(), position2.getY());
}
/**
* Gets the distance in tiles between two map positions.
*
* @param ax
* Position A x-coordinate
* @param ay
* Position A y-coordinate
* @param bx
* Position B x-coordinate
* @param by
* Position B y-coordinate
* @return Distance
*/
public int getDistance(int ax, int ay, int bx, int by) {
int r = bx - ax - (ay - by) / 2;
if (by > ay && ay % 2 == 0 && by % 2 != 0) {
r++;
} else if (by < ay && ay % 2 != 0 && by % 2 == 0) {
r--;
}
return Math.max(Math.abs(ay - by + r), Math.abs(r));
}
/**
* Represents a position on the Map.
*/
public static final class Position {
public final int x, y;
/**
* Creates a new object with the given position.
*
* @param posX
* The x-coordinate for this position.
* @param posY
* The y-coordinate for this position.
*/
public Position(int posX, int posY) {
x = posX;
y = posY;
}
/**
* Returns the x-coordinate of this Position.
*
* @return The x-coordinate of this Position.
*/
public int getX() {
return x;
}
/**
* Returns the y-coordinate of this Position.
*
* @return The y-coordinate of this Position.
*/
public int getY() {
return y;
}
/**
* Compares the other Position based on the coordinates.
*
* @param other the reference object with which to compare.
* @return true iff the coordinates match.
*/
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
} else if (other == null) {
return false;
} else if (!(other instanceof Position)) {
return false;
} else {
return x == ((Position) other).x && y == ((Position) other).y;
}
}
/**
* Returns a hash code value. The current implementation (which may
* change at any time) works well as long as the maximum coordinates fit
* in 16 bits.
*
* @return a hash code value for this object.
*/
@Override
public int hashCode() {
return x | (y << 16);
}
/**
* Returns a string representation of the object.
*
* @return a string representation of the object.
*/
@Override
public String toString() {
return "(" + x + ", " + y + ")";
}
}
/**
* Base class for internal iterators.
*/
private abstract class MapIterator implements Iterator<Position> {
protected Direction[] directions = Direction.values();
/**
* Get the next position as a position rather as an object.
*
* @return position.
* @throws NoSuchElementException
* if iterator is exhausted.
*/
public abstract Position nextPosition() throws NoSuchElementException;
/**
* Returns the next element in the iteration.
*
* @return the next element in the iteration.
* @exception NoSuchElementException
* iteration has no more elements.
*/
public Position next() {
return nextPosition();
}
/**
* Removes from the underlying collection the last element returned by
* the iterator (optional operation).
*
* @exception UnsupportedOperationException
* no matter what.
*/
public void remove() {
throw new UnsupportedOperationException();
}
}
private final class WholeMapIterator extends MapIterator {
private int x;
private int y;
/**
* Default constructor.
*/
public WholeMapIterator() {
x = 0;
y = 0;
}
/**
* Determine if the iterator has another position in it.
*
* @return True of there is another position
*/
public boolean hasNext() {
return y < getHeight();
}
/**
* Obtain the next position to iterate over.
*
* @return Next position
* @throws java.util.NoSuchElementException
* if last position already returned
*/
@Override
public Position nextPosition() throws NoSuchElementException {
if (y < getHeight()) {
Position newPosition = new Position(x, y);
x++;
if (x == getWidth()) {
x = 0;
y++;
}
return newPosition;
}
throw new NoSuchElementException("Iterator exhausted");
}
}
private final class AdjacentIterator extends MapIterator {
// The starting tile position
private Position basePosition;
// Index into the list of adjacent tiles
private int x = 0;
/**
* The constructor to use.
*
* @param basePosition
* The position around which to iterate
*/
public AdjacentIterator(Position basePosition) {
this.basePosition = basePosition;
}
/**
* Determine if the iterator has another position in it.
*
* @return True of there is another position
*/
public boolean hasNext() {
for (int i = x; i < 8; i++) {
Position newPosition = getAdjacent(basePosition, directions[i]);
if (isValid(newPosition))
return true;
}
return false;
}
/**
* Obtain the next position to iterate over.
*
* @return Next position
* @throws NoSuchElementException
* if last position already returned
*/
@Override
public Position nextPosition() throws NoSuchElementException {
for (int i = x; i < 8; i++) {
Position newPosition = getAdjacent(basePosition, directions[i]);
if (isValid(newPosition)) {
x = i + 1;
return newPosition;
}
}
throw new NoSuchElementException("Iterator exhausted");
}
}
/**
* An interator returning positions in a spiral starting at a given center
* tile. The center tile is never included in the positions returned, and
* all returned positions are valid.
*
* @see Map.Position
*/
public final class CircleIterator extends MapIterator {
private int radius;
private int currentRadius;
private Position nextPosition = null;
// The current position in the circle with the current radius:
private int n;
/**
* The constructor to use.
*
* @param center
* The center of the circle
* @param isFilled
* True to get all of the positions within the circle
* @param radius
* The radius of the circle
*/
public CircleIterator(Position center, boolean isFilled, int radius) {
this.radius = radius;
if (center == null) {
throw new IllegalArgumentException("center must not be 'null'.");
}
n = 0;
if (isFilled || radius == 1) {
nextPosition = getAdjacent(center, Direction.NE);
currentRadius = 1;
} else {
currentRadius = radius;
nextPosition = center;
for (int i = 1; i < radius; i++) {
nextPosition = getAdjacent(nextPosition, Direction.N);
}
nextPosition = getAdjacent(nextPosition, Direction.NE);
}
if (!isValid(nextPosition)) {
determineNextPosition();
}
}
/**
* Returns the current radius of the circle.
*
* @return The distance from the center tile this
* <code>CircleIterator</code> was initialized with.
*/
public int getCurrentRadius() {
return currentRadius;
}
/**
* Finds the next position.
*/
private void determineNextPosition() {
boolean positionReturned = (n != 0);
do {
n++;
final int width = currentRadius * 2;
if (n >= width * 4) {
currentRadius++;
if (currentRadius > radius) {
nextPosition = null;
} else if (!positionReturned) {
nextPosition = null;
} else {
n = 0;
positionReturned = false;
nextPosition = getAdjacent(nextPosition, Direction.NE);
}
} else {
int i = n / width;
Direction direction;
switch (i) {
case 0:
direction = Direction.SE;
break;
case 1:
direction = Direction.SW;
break;
case 2:
direction = Direction.NW;
break;
case 3:
direction = Direction.NE;
break;
default:
throw new IllegalStateException("i=" + i + ", n=" + n
+ ", width=" + width);
}
nextPosition = getAdjacent(nextPosition, direction);
}
} while (nextPosition != null && !isValid(nextPosition));
}
/**
* Determine if the iterator has another position in it.
*
* @return <code>true</code> of there is another position and
* <code>false</code> otherwise.
*/
public boolean hasNext() {
return nextPosition != null;
}
/**
* Obtains the next position.
*
* @return The next position. This position is guaratied to be
* {@link Map#isValid(net.sf.freecol.common.model.Map.Position) valid}.
*/
@Override
public Position nextPosition() {
if (nextPosition != null) {
final Position p = nextPosition;
determineNextPosition();
return p;
} else {
return null;
}
}
}
private final class BorderAdjacentIterator extends MapIterator {
// The starting tile position
private Position basePosition;
// Index into the list of adjacent tiles
private int index;
/**
* The constructor to use.
*
* @param basePosition
* The position around which to iterate
*/
public BorderAdjacentIterator(Position basePosition) {
this.basePosition = basePosition;
index = 1;
}
/**
* Determine if the iterator has another position in it.
*
* @return True of there is another position
*/
public boolean hasNext() {
for (int i = index; i < 8; i += 2) {
Position newPosition = getAdjacent(basePosition, directions[i]);
if (isValid(newPosition))
return true;
}
return false;
}
/**
* Obtain the next position to iterate over.
*
* @return Next position
* @throws NoSuchElementException
* if last position already returned
*/
@Override
public Position nextPosition() throws NoSuchElementException {
for (int i = index; i < 8; i += 2) {
Position newPosition = getAdjacent(basePosition, directions[i]);
if (isValid(newPosition)) {
index = i + 2;
return newPosition;
}
}
throw new NoSuchElementException("Iterator exhausted");
}
}
/**
* This method writes an XML-representation of this object to the given
* stream.
*
* <br>
* <br>
*
* Only attributes visible to the given <code>Player</code> will be added
* to that representation if <code>showAll</code> is set to
* <code>false</code>.
*
* @param out
* The target stream.
* @param player
* The <code>Player</code> this XML-representation should be
* made for, or <code>null</code> if
* <code>showAll == true</code>.
* @param showAll
* Only attributes visible to <code>player</code> will be added
* to the representation if <code>showAll</code> is set to
* <i>false</i>.
* @param toSavedGame
* If <code>true</code> then information that is only needed
* when saving a game is added.
* @throws XMLStreamException
* if there are any problems writing to the stream.
*/
@Override
protected void toXMLImpl(XMLStreamWriter out, Player player,
boolean showAll, boolean toSavedGame) throws XMLStreamException {
// Start element:
out.writeStartElement(getXMLElementTagName());
out.writeAttribute("ID", getId());
out.writeAttribute("width", Integer.toString(getWidth()));
out.writeAttribute("height", Integer.toString(getHeight()));
for (Region region : regions.values()) {
region.toXML(out);
}
Iterator<Position> tileIterator = getWholeMapIterator();
while (tileIterator.hasNext()) {
Tile tile = getTile(tileIterator.next());
if (showAll || player.hasExplored(tile)) {
tile.toXML(out, player, showAll, toSavedGame);
} else {
Tile hiddenTile = new Tile(getGame(), null, tile.getX(), tile.getY());
hiddenTile.setFakeID(tile.getId());
hiddenTile.toXML(out, player, showAll, toSavedGame);
}
}
out.writeEndElement();
}
/**
* Initialize this object from an XML-representation of this object.
*
* @param in
* The input stream with the XML.
*/
@Override
protected void readFromXMLImpl(XMLStreamReader in)
throws XMLStreamException {
setId(in.getAttributeValue(null, "ID"));
if (tiles == null) {
int width = Integer.parseInt(in.getAttributeValue(null, "width"));
int height = Integer.parseInt(in.getAttributeValue(null, "height"));
tiles = new Tile[width][height];
}
while (in.nextTag() != XMLStreamConstants.END_ELEMENT) {
if (in.getLocalName().equals(Tile.getXMLElementTagName())) {
Tile t = updateFreeColGameObject(in, Tile.class);
setTile(t, t.getX(), t.getY());
} else if (in.getLocalName().equals(Region.getXMLElementTagName())) {
setRegion(updateFreeColGameObject(in, Region.class));
} else {
logger.warning("Unknown tag: " + in.getLocalName() + " loading map");
in.nextTag();
}
}
}
/**
* Returns the tag name of the root element representing this object.
*
* @return the tag name.
*/
public static String getXMLElementTagName() {
return "map";
}
/**
* Make the map usable as a parameter in the for-loop.
*
* Returns all Tiles based on the order of the WholeMapIterator.
*
* @return An Iterable that can be used to get an iterator for all tiles of the map.
*/
public Iterable<Tile> getAllTiles() {
return new Iterable<Tile>(){
public Iterator<Tile> iterator(){
final WholeMapIterator m = getWholeMapIterator();
return new Iterator<Tile>(){
public boolean hasNext() {
return m.hasNext();
}
public Tile next() {
return getTile(m.next());
}
public void remove() {
m.remove();
}
};
}
};
}
}
The table below shows all metrics for Map.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 217.00 | Number of blocks | |
| BLOCK_COMMENT | 17.00 | Number of block comment lines | |
| COMMENTS | 843.00 | Comment lines | |
| COMMENT_DENSITY | 1.25 | Comment density | |
| COMPARISONS | 157.00 | Number of comparison operators | |
| CYCLOMATIC | 227.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 85.00 | Comments in declarations | |
| DOC_COMMENT | 807.00 | Number of javadoc comment lines | |
| ELOC | 673.00 | Effective lines of code | |
| EXEC_COMMENTS | 16.00 | Comments in executable code | |
| EXITS | 113.00 | Procedure exits | |
| FUNCTIONS | 87.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 133.13 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 264.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 2.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 1.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 7.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 8.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 1.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 1.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 5.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 4.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 3.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 2.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 4.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 1.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 1.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 2.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 1863.00 | Number of lines in the source file | |
| LINE_COMMENT | 19.00 | Number of line comments | |
| LOC | 861.00 | Lines of code | |
| LOGICAL_LINES | 383.00 | Number of statements | |
| LOOPS | 17.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 1917.00 | Number of operands | |
| OPERATORS | 3913.00 | Number of operators | |
| PARAMS | 120.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 5830.00 | Halstead program length | |
| PROGRAM_VOCAB | 574.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 144.00 | Number of return points from functions | |
| SIZE | 65714.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 504.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 70.00 | Number of unique operators | |
| WHITESPACE | 159.00 | Number of whitespace lines | |