Skip to content
Snippets Groups Projects
Commit 35bcf014 authored by Goik Martin's avatar Goik Martin
Browse files

Javadoc corrections

parent 053109a5
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Klausuren/Sd1/2017winter/Exam/src/main/java/de/hdm_stuttgart/mi/sd1/aufgabe2/MaexleWurf.java
+ 48
− 38
View file @ 35bcf014
package de.hdm_stuttgart.mi.sd1.aufgabe2;
import de.hdm_stuttgart.mi.sd1.aufgabe1.Maexchen;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
/**
* <p>Darstellung eines Mäxchen Wurfs, z.B. (3|2), siehe auch {@link Maexchen}.</p>
* <p>Darstellung eines Mäxchen Wurfs, z.B. (3|2), siehe auch die Erläuterungen in {@link Maexchen}.</p>
*/
public class MaexleWurf {
static private Logger log = LogManager.getLogger(MaexleWurf.class);
/**
* Ein Wurf bestehend aus den Augenzahlen beider Würfel. Die Reihenfolge der Augenzahlen spielt dabei keine Rolle.
*
* @param wuerfel1 Augenzahl des ersten Würfels.
* @param wuerfel2 Augenzahl des zweiten Würfels.
*/
public MaexleWurf(final int wuerfel1, final int wuerfel2) {
// TODO: Implementiere mich richtig!
}
/**
* <p>Vergleiche den aktuellen Wurf mit einem anderen Wurf: Welcher Wurf ist höher?</p>
* <p>Vergleiche den aktuellen Wurf mit einem anderen Wurf: Welches Paar von Augenzahlen liegt höher? Nachfolgend
* die Werte in aufsteigender Reihenfolge:</p>
*
* <table border="1" style="border-collapse: collapse;" >
* <tr>
* <th >Typ</th>
* <th >Würfe aufsteigend</th>
* </tr>
*
* <tr>
* <td rowspan="4" style='vertical-align: top;'>Standard</td>
* <td>(3|1) (3|2)</td>
* </tr>
*
* <tr>
* <td>(4|1) (4|2) (4|3)</td>
* </tr>
*
* <table border="1" style="border-collapse: collapse;">
* <tr>
* <th colspan="14">Normalwerte</th>
* <th colspan="6">Pasch</th>
* <th>Mäxle</th>
* <td>(5|1) (5|2) (5|3) (5|4)</td>
* </tr>
*
* <tr>
* <td>(3|1)</td><td>(3|2)</td>
* <td>(4|1)</td><td>(4|2)</td><td>(4|3)</td>
* <td>(5|1)</td><td>(5|2)</td><td>(5|3)</td><td>(5|4)</td>
* <td>(6|1)</td><td>(6|2)</td><td>(6|3)</td><td>(6|4)</td><td>(6|5)</td>
*
* <td>(1|1)</td>
* <td>(2|2)</td>
* <td>(3|3)</td>
* <td>(4|4)</td>
* <td>(5|5)</td>
* <td>(6|6)</td>
*
* <td>(1|2)</td>
* <td>(6|1) (6|2) (6|3) (6|4) (6|5)</td>
* </tr>
*
* <tr>
* <td>Niedrigster Wert</td>
* <td colspan="19"></td>
* <td>Höchster Wert</td>
* <td style='vertical-align: top;'>Pasch</td>
* <td>(1|1) (2|2) (3|3) (4|4) (5|5) (6|6)</td>
* </tr>
* <caption>Reihenfolge gewürfelter Augenpaare in aufsteigender Folge im Mäxchen Spiel.</caption>
*
* <tr>
* <td style='vertical-align: top;'>Mäxle</td>
* <td>(2|1)</td>
* </tr>
*
* <caption>Reihenfolge gewürfelter Augenpaare in aufsteigender Folge im Mäxle Spiel.</caption>
* </table>
*
* <p>Damit ergibt sich die Reihenfolge gewürfelter Werte zu:</p>
*
* <pre>31, 32, 41, 42, 43, 51, 52, 53, 54, 61, 62, 63, 64, 65, 11, 22, 33, 44, 55, 66, 21</pre>
*
* <p>Beispiele:</p>
*
* <ul>
* <li><code>(2| 5)</code> gleich <code>(5| 2)</code> wird »52« gesprochen und ist größer als (4| 3), gesprochen
* »43«</li>
* <li><code>(2|5)</code> wird »52« gesprochen und ist gleichwertig zu <code>(5|2)</code>. Dieser Wurf liegt über
* z.B. (4|3) bzw. (3|4), gesprochen »43«</li>
*
* <li><code>(2| 2)</code> ist als höher als alle nicht-Pasch / nicht-Mäxchen Werte wie z.B. <code>(5| 6)</code>,
* aber niedriger als das Mäxchen <code>(1|2)</code>.</li>
* <li><code>(2|2)</code> ist als höher als alle nicht- Pasch/Mäxle Werte wie z.B. <code>(6|5)</code>,
* aber niedriger als das Mäxchen <code>(2|1)</code>.</li>
*
* </ul>
*
* @param other Ein im Spiel geworfener Wert bestehend aus den Augenzahlen zweier Würfel, mit welchem der atuelle
* Wert verglichen wird.
* @param anderer Ein im Spiel geworfener Wert bestehend aus den Augenzahlen zweier Würfel.
*
* @return <ul>
* <li>positives Ergebnis, falls fremder Wert höher liegt.</li>
* <li>0, falls fremder Wert gleich ist</li>
* <li>0, falls Wert gleich ist</li>
* <li>negatives Ergebnis, falls fremder Wert niedriger liegt.</li>
* </ul>
*/
public int compareTo(final MaexleWurf other) {
// Auskommentieren und mit sinnvoller Ausgabe versehen:
//log.info(this + " compareTo(" + other + ")");
public int compareTo(final MaexleWurf anderer) {
return -12345; // TODO: Implementiere mich richtig!
}
}
\ No newline at end of file
Klausuren/Sd1/2017winter/Solve/src/main/java/de/hdm_stuttgart/mi/sd1/aufgabe2/MaexleWurf.java
+ 28
− 35
View file @ 35bcf014
......@@ -7,7 +7,7 @@ import de.hdm_stuttgart.mi.sd1.aufgabe1.Maexchen;
*/
public class MaexleWurf {
final int untereAugenzahl, obereAugenzahl;
private final int untereAugenzahl, obereAugenzahl;
/**
* Ein Wurf bestehend aus den Augenzahlen beider Würfel. Die Reihenfolge der Augenzahlen spielt dabei keine Rolle.
......@@ -27,7 +27,7 @@ public class MaexleWurf {
}
/**
* <p>Vergleiche den aktuellen Wurf mit einem anderen Wurf: Welches Paar von Augenzahlenliegt höher? Nachfolgend
* <p>Vergleiche den aktuellen Wurf mit einem anderen Wurf: Welches Paar von Augenzahlen liegt höher? Nachfolgend
* die Werte in aufsteigender Reihenfolge:</p>
*
* <table border="1" style="border-collapse: collapse;" >
......@@ -35,60 +35,53 @@ public class MaexleWurf {
* <th >Typ</th>
* <th >Würfe aufsteigend</th>
* </tr>
* <tr>
* <td style='vertical-align: top;'>Standard</td>
* <td><pre>(3|1) (3|2)
*(4|1) (4|2) (4|3)
*(5|1) (5|2) (5|3) (5|4)
*(6|1) (6|2) (6|3) (6|4) (6|5)</pre></td></tr>
*
* <caption>Reihenfolge gewürfelter Augenpaare in aufsteigender Folge im Mäxchen Spiel.</caption>
* </table>
* <tr>
* <td rowspan="4" style='vertical-align: top;'>Standard</td>
* <td>(3|1) (3|2)</td>
* </tr>
*
* <tr>
* <td>(4|1) (4|2) (4|3)</td>
* </tr>
*
* <table border="1" style="border-collapse: collapse;" id="werteFolgeAufsteigend">
* <tr>
* <th colspan="14">Normalwerte</th>
* <th colspan="6">Pasch</th>
* <th>Mäxle</th>
* <td>(5|1) (5|2) (5|3) (5|4)</td>
* </tr>
*
* <tr>
* <td>(3|1)</td><td>(3|2)</td>
* <td>(4|1)</td><td>(4|2)</td><td>(4|3)</td>
* <td>(5|1)</td><td>(5|2)</td><td>(5|3)</td><td>(5|4)</td>
* <td>(6|1)</td><td>(6|2)</td><td>(6|3)</td><td>(6|4)</td><td>(6|5)</td>
*
* <td>(1|1)</td>
* <td>(2|2)</td>
* <td>(3|3)</td>
* <td>(4|4)</td>
* <td>(5|5)</td>
* <td>(6|6)</td>
* <td>(6|1) (6|2) (6|3) (6|4) (6|5)</td>
* </tr>
*
* <td>(2|1)</td>
* <tr>
* <td style='vertical-align: top;'>Pasch</td>
* <td>(1|1) (2|2) (3|3) (4|4) (5|5) (6|6)</td>
* </tr>
*
* <tr>
* <td>Niedrigster Wert</td>
* <td colspan="19"></td>
* <td>Höchster Wert</td>
* <td style='vertical-align: top;'>Mäxle</td>
* <td>(2|1)</td>
* </tr>
* <caption>Reihenfolge gewürfelter Augenpaare in aufsteigender Folge im Mäxchen Spiel.</caption>
*
* <caption>Reihenfolge gewürfelter Augenpaare in aufsteigender Folge im Mäxle Spiel.</caption>
* </table>
*
* <p>Damit ergibt sich die Reihenfolge gewürfelter Werte zu:</p>
*
* <pre>31, 32, 41, 42, 43, 51, 52, 53, 54, 61, 62, 63, 64, 65, 11, 22, 33, 44, 55, 66, 21</pre>
*
* <p>Beispiele:</p>
*
* <ul>
* <li><code>(2|5)</code> wird »52« gesprochen und ist gleichwertig zu <code>(5|2)</code>. Dieser Wurf liegt über
* z.B. (4|3) bzw. (3|4), gesprochen »43«</li>
*
* <li><code>(2|2)</code> ist als höher als alle nicht-Pasch / nicht-Mäxchen Werte wie z.B. <code>(5|6)</code>,
* <li><code>(2|2)</code> ist als höher als alle nicht- Pasch/Mäxle Werte wie z.B. <code>(6|5)</code>,
* aber niedriger als das Mäxchen <code>(2|1)</code>.</li>
*
* </ul>
*
* @param wurf Ein im Spiel geworfener Wert bestehend aus den Augenzahlen zweier Würfel.
* @param anderer Ein im Spiel geworfener Wert bestehend aus den Augenzahlen zweier Würfel.
*
* @return <ul>
* <li>positives Ergebnis, falls fremder Wert höher liegt.</li>
......@@ -96,8 +89,8 @@ public class MaexleWurf {
* <li>negatives Ergebnis, falls fremder Wert niedriger liegt.</li>
* </ul>
*/
public int compareTo(final MaexleWurf wurf) {
return wurf.getWert() - getWert();
public int compareTo(final MaexleWurf anderer) {
return anderer.getWert() - getWert();
}
private int getWert() {
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment