24
24
25
25
/**
26
26
* Defines an object which represents the three dimensional plane and how a device can be rotated
27
- * about it. Each of the axis is in positive degrees on the real number scale (0 <= deg <=
27
+ * about it. Each of the axes is in positive degrees on the real number scale (0 <= deg <=
28
28
* 360).
29
29
*
30
- * <p>Example Instantiation to rotate device to "Landscape Right": DeviceRotation(0, 0, 90);
30
+ * <p>Example instantiation to rotate device to "Landscape Right": DeviceRotation(0, 0, 90);
31
31
*/
32
32
public class DeviceRotation {
33
- //Default orientation is portrait
33
+ // The default orientation is portrait.
34
34
private int x = 0 ;
35
35
private int y = 0 ;
36
36
private int z = 0 ;
@@ -46,7 +46,7 @@ public DeviceRotation(int x, int y, int z) {
46
46
}
47
47
48
48
/**
49
- * Instantiate a DeviceRotation object based on a HashMap object where the keys are the axis x, y,
49
+ * Instantiate a DeviceRotation object based on a HashMap object where the keys are the axes x, y,
50
50
* and z respectively: x : xVal y : yVal z : zVal
51
51
*/
52
52
public DeviceRotation (Map <String , Number > map ) {
@@ -75,22 +75,22 @@ private void validateParameters(int x, int y, int z) {
75
75
}
76
76
}
77
77
78
- /** @return the x */
78
+ /** @return The x. */
79
79
public int getX () {
80
80
return x ;
81
81
}
82
82
83
- /** @return the y */
83
+ /** @return The y. */
84
84
public int getY () {
85
85
return y ;
86
86
}
87
87
88
- /** @return the z */
88
+ /** @return The z. */
89
89
public int getZ () {
90
90
return z ;
91
91
}
92
92
93
- /** @return returns all axis mapped to a Map */
93
+ /** @return All axes mapped to a Map. */
94
94
public Map <String , Integer > parameters () {
95
95
HashMap <String , Integer > values = new HashMap <>();
96
96
values .put ("x" , this .x );
0 commit comments