Auto reformaterer alle klasser og tester for objektegenskaper

This commit is contained in:
Kristian Knarvik 2020-04-20 13:10:13 +02:00
parent 91bdcd8394
commit afe9e67969
8 changed files with 140 additions and 111 deletions

View File

@ -17,24 +17,18 @@ public enum Direction {
/** /**
* Constructor to let a direction to be represented by a numerical identifier * Constructor to let a direction to be represented by a numerical identifier
* @param directionID <p>The numerical identifier assigned to the direction</p> *
* @param directionID The numerical identifier assigned to the direction
*/ */
Direction(int directionID) { Direction(int directionID) {
this.directionID = directionID; this.directionID = directionID;
} }
/**
* Gets the numerical identifier used for alternate identification of a direction
* @return <p>The numerical id of the direction</p>
*/
public int getDirectionID() {
return this.directionID;
}
/** /**
* Gets a direction from its numerical id * Gets a direction from its numerical id
* @param directionID <p>The numerical representation of a direction</p> *
* @return <p>The enum value representing the direction, or null if the id is invalid</p> * @param directionID The numerical representation of a direction
* @return The enum value representing the direction, or null if the id is invalid
*/ */
public static Direction getDirectionFromID(int directionID) { public static Direction getDirectionFromID(int directionID) {
for (Direction direction : Direction.values()) { for (Direction direction : Direction.values()) {
@ -47,6 +41,7 @@ public enum Direction {
/** /**
* Checks whether two directions are perpendicular * Checks whether two directions are perpendicular
*
* @param direction1 The first direction * @param direction1 The first direction
* @param direction2 The second direction * @param direction2 The second direction
* @return True if the directions are perpendicular * @return True if the directions are perpendicular
@ -58,6 +53,7 @@ public enum Direction {
/** /**
* Gets the reverse of a direction * Gets the reverse of a direction
*
* @param direction A direction * @param direction A direction
* @return The reverse direction * @return The reverse direction
*/ */
@ -68,7 +64,7 @@ public enum Direction {
/** /**
* Gets the direction if something rotated to the left * Gets the direction if something rotated to the left
* *
* A rotation is assumed to be a ninety degrees rotation, so NORTH would become WEST and so on. * <p>A rotation is assumed to be a ninety degrees rotation, so NORTH would become WEST and so on.</p>
* *
* @param direction A direction * @param direction A direction
* @return The left rotated direction * @return The left rotated direction
@ -80,7 +76,7 @@ public enum Direction {
/** /**
* Gets the direction if something rotated to the right * Gets the direction if something rotated to the right
* *
* A rotation is assumed to be a ninety degrees rotation, so NORTH would become EAST and so on. * <p>A rotation is assumed to be a ninety degrees rotation, so NORTH would become EAST and so on.</p>
* *
* @param direction A direction * @param direction A direction
* @return The left rotated direction * @return The left rotated direction
@ -88,4 +84,13 @@ public enum Direction {
public static Direction getRightRotatedDirection(Direction direction) { public static Direction getRightRotatedDirection(Direction direction) {
return getDirectionFromID((((direction.getDirectionID() + 1) % 8) + 1)); return getDirectionFromID((((direction.getDirectionID() + 1) % 8) + 1));
} }
/**
* Gets the numerical identifier used for alternate identification of a direction
*
* @return The numerical id of the direction
*/
public int getDirectionID() {
return this.directionID;
}
} }

View File

@ -10,24 +10,18 @@ public enum ParticleType {
/** /**
* Constructor to let a particle type be represented by a numerical identifier * Constructor to let a particle type be represented by a numerical identifier
* @param particleTypeID <p>The numerical identifier assigned to the particle type</p> *
* @param particleTypeID The numerical identifier assigned to the particle type
*/ */
ParticleType(int particleTypeID) { ParticleType(int particleTypeID) {
this.particleTypeID = particleTypeID; this.particleTypeID = particleTypeID;
} }
/**
* Gets the numerical id used for alternate identification of a tile type
* @return <p>The numerical id of the tile type</p>
*/
public int getParticleTypeID() {
return this.particleTypeID;
}
/** /**
* Gets a particle type value from its numerical representation * Gets a particle type value from its numerical representation
* @param particleTypeID <p>The numerical representation of a particle type</p> *
* @return <p>The enum value representing the particle type, or null if the id is invalid</p> * @param particleTypeID The numerical representation of a particle type
* @return The enum value representing the particle type, or null if the id is invalid
*/ */
public static ParticleType getParticleTypeFromID(int particleTypeID) { public static ParticleType getParticleTypeFromID(int particleTypeID) {
for (ParticleType type : ParticleType.values()) { for (ParticleType type : ParticleType.values()) {
@ -37,4 +31,13 @@ public enum ParticleType {
} }
return null; return null;
} }
/**
* Gets the numerical id used for alternate identification of a tile type
*
* @return The numerical id of the tile type
*/
public int getParticleTypeID() {
return this.particleTypeID;
}
} }

View File

@ -10,6 +10,7 @@ public class Position {
/** /**
* Initializes the position * Initializes the position
*
* @param xCoordinate The x coordinate of the position * @param xCoordinate The x coordinate of the position
* @param yCoordinate The y coordinate of the position * @param yCoordinate The y coordinate of the position
*/ */
@ -20,6 +21,7 @@ public class Position {
/** /**
* Gets the x coordinate of the position * Gets the x coordinate of the position
*
* @return The x coordinate of the position * @return The x coordinate of the position
*/ */
public int getXCoordinate() { public int getXCoordinate() {
@ -28,6 +30,7 @@ public class Position {
/** /**
* Gets the y coordinate of the position * Gets the y coordinate of the position
*
* @return The y coordinate of the position * @return The y coordinate of the position
*/ */
public int getYCoordinate() { public int getYCoordinate() {

View File

@ -17,24 +17,18 @@ public enum RobotID {
/** /**
* Constructor to let a robotID be represented by a numerical identifier * Constructor to let a robotID be represented by a numerical identifier
* @param robotID <p>The numerical identifier assigned to the robot ID</p> *
* @param robotID The numerical identifier assigned to the robot ID
*/ */
RobotID(int robotID) { RobotID(int robotID) {
this.robotID = robotID; this.robotID = robotID;
} }
/**
* Gets the numerical id used for identification of a robot id
* @return <p>The numerical id of the robot id</p>
*/
public int getRobotIDID() {
return this.robotID;
}
/** /**
* Gets a robot ID value from its numerical representation * Gets a robot ID value from its numerical representation
* @param robotID <p>The numerical representation of a robot id</p> *
* @return <p>The enum value representing the robot ID, or null if the id is invalid</p> * @param robotID The numerical representation of a robot id
* @return The enum value representing the robot ID, or null if the id is invalid
*/ */
public static RobotID getRobotIDFromID(int robotID) { public static RobotID getRobotIDFromID(int robotID) {
for (RobotID type : RobotID.values()) { for (RobotID type : RobotID.values()) {
@ -44,4 +38,13 @@ public enum RobotID {
} }
return null; return null;
} }
/**
* Gets the numerical id used for identification of a robot id
*
* @return The numerical id of the robot id
*/
public int getRobotIDID() {
return this.robotID;
}
} }

View File

@ -44,24 +44,18 @@ public enum TileType {
/** /**
* Constructor to let a tile type be represented by a numerical identifier * Constructor to let a tile type be represented by a numerical identifier
* @param tileTypeID <p>The numerical identifier assigned to the tile type</p> *
* @param tileTypeID The numerical identifier assigned to the tile type
*/ */
TileType(int tileTypeID) { TileType(int tileTypeID) {
this.tileTypeID = tileTypeID; this.tileTypeID = tileTypeID;
} }
/**
* Gets the numerical id used for alternate identification of a tile type
* @return <p>The numerical id of the tile type</p>
*/
public int getTileTypeID() {
return this.tileTypeID;
}
/** /**
* Gets a tile type value from its numerical representation * Gets a tile type value from its numerical representation
* @param tileTypeID <p>The numerical representation of a tile type</p> *
* @return <p>The enum value representing the tile type, or null if the id is invalid</p> * @param tileTypeID The numerical representation of a tile type
* @return The enum value representing the tile type, or null if the id is invalid
*/ */
public static TileType getTileTypeFromID(int tileTypeID) { public static TileType getTileTypeFromID(int tileTypeID) {
for (TileType type : TileType.values()) { for (TileType type : TileType.values()) {
@ -71,4 +65,13 @@ public enum TileType {
} }
return null; return null;
} }
/**
* Gets the numerical id used for alternate identification of a tile type
*
* @return The numerical id of the tile type
*/
public int getTileTypeID() {
return this.tileTypeID;
}
} }

View File

@ -13,24 +13,18 @@ public enum WallType {
/** /**
* Constructor to let a wall type be represented by a numerical identifier * Constructor to let a wall type be represented by a numerical identifier
* @param wallTypeID <p>The numerical identifier assigned to the wall type</p> *
* @param wallTypeID The numerical identifier assigned to the wall type
*/ */
WallType(int wallTypeID) { WallType(int wallTypeID) {
this.wallTypeID = wallTypeID; this.wallTypeID = wallTypeID;
} }
/**
* Gets the numerical id used for alternate identification of a wall type
* @return <p>The numerical id of the wall type</p>
*/
public int getWallTypeID() {
return this.wallTypeID;
}
/** /**
* Gets a wall type value from its numerical representation * Gets a wall type value from its numerical representation
* @param wallTypeID <p>The numerical representation of a wall type</p> *
* @return <p>The enum value representing the wall type, or null if the id is invalid</p> * @param wallTypeID The numerical representation of a wall type
* @return The enum value representing the wall type, or null if the id is invalid
*/ */
public static WallType getWallTypeFromID(int wallTypeID) { public static WallType getWallTypeFromID(int wallTypeID) {
for (WallType type : WallType.values()) { for (WallType type : WallType.values()) {
@ -40,4 +34,13 @@ public enum WallType {
} }
return null; return null;
} }
/**
* Gets the numerical id used for alternate identification of a wall type
*
* @return The numerical id of the wall type
*/
public int getWallTypeID() {
return this.wallTypeID;
}
} }

View File

@ -23,6 +23,7 @@ public class PositionTest {
testPosition5 = new Position(1, 4); testPosition5 = new Position(1, 4);
testPosition6 = new Position(3, 3); testPosition6 = new Position(3, 3);
} }
@Test @Test
public void testGetXPosition() { public void testGetXPosition() {
assertEquals(3, testPosition1.getXCoordinate()); assertEquals(3, testPosition1.getXCoordinate());
@ -34,14 +35,22 @@ public class PositionTest {
} }
@Test @Test
public void testSamePositionsAreEqual() { assertEquals(testPosition1, testPosition3);} public void testSamePositionsAreEqual() {
assertEquals(testPosition1, testPosition3);
@Test }
public void testDifferentPositionsAreNotEqual() { assertNotEquals(testPosition2, testPosition4);}
@Test
@Test public void testDifferentPositionsAreNotEqual() {
public void equalXandDifferentYIsNotEqual() { assertNotEquals(testPosition1, testPosition6);} assertNotEquals(testPosition2, testPosition4);
}
@Test
public void equalYandDifferentXIsNotEqual() { assertNotEquals(testPosition1, testPosition5);} @Test
public void equalXandDifferentYIsNotEqual() {
assertNotEquals(testPosition1, testPosition6);
}
@Test
public void equalYandDifferentXIsNotEqual() {
assertNotEquals(testPosition1, testPosition5);
}
} }