boolean return typ verwenden?

[Bit2_Gosu]

Hi!

Ich frage mich, wann es sinnvoll ist, über den return typ boolean Aussagen über Operationen zu liefern. Sagen wir, wir haben ein Schachbrett und es gibt eine Funktion, die sagt, ob ein Feld mit einer Figur besetzt ist und eine Funktion "setPiece()", die auf ein Feld eine Figur setzt. Jetzt könnte ich der setPiece-Funktion den return typ boolean geben und sie true zurückgeben lassen, wenn auf dem Feld vorher schon eine Figur stand, die jetzt durch die Funktion geschlagen wurde. Ich könnte aber auch sagen: "Wozu? Der Benutzer kann vorher die andere Funktion benutzen, um zu schauen ob da eine Figur steht, und dann die setPiece() Funktion aufrufen." Meiner Meinung nach ist folgendes auch NICHT sehr leserlich:

if (setPiece(feldID, figur)) {
    System.out.println("Eine Figur wurde geschlagen!");
}

Hier muss der Benutzer auch erst die Doku der setPiece() Funktion anschauen, um zu wissen, für was der Rückgabetyp steht.
Das hier finde ich besser:

if (feld.containsPiece()) {
    System.out.println("Eine Figur wurde geschlagen!");
}
setPiece(feldID, figur);

Andererseits ist ersteres kürzer... Wie steht ihr dazu? Bzw. was ist üblich und gilt als besserer Stil?

 

[SlaterB]

tja, was ist schon üblich,

nützlich ist es vielleicht, wenn man die Methode häufig verwendet,
für Set und Map in den util-Collections geben die Methoden add/put einen boolean zurück, ob der das Element/ der Key schon bekannt war,
ansonsten würden nämlich unzählige Aufrufe
if (map.contains(..)) { .. } else { add(..) }
lauten

je spezielle und seltener eine Methode ist, desto weniger lohnt sind eine solche Abkürzung

 

[Marco13]

Wenn das mit dem Schach nicht nur ein Beispiel sein sollte: Such' mal nach "schlagen en passant"

Ansonsten kommt's IMHO schon auf die genaue Semantik an. Schau' vielleicht mal im java.util.List interface. Dort gibt "add" z.B. ein boolean zurück, "set" gibt das Element zurück, das vorher dort war - aber "contains" gibt's auch...

 

[Bleistift]

Das Beispiel mit dem Schachbrett ist vielleicht etwas unpraktisch. Es kann ja auch eine Figur der gleichen Farbe auf dem Feld stehen und der Zug dadurch unmöglich sein. Grundsätzlich wäre ich eher für die kürzere Variante.
mfg Bleistift

 

[Marco13]

"Grundsätzlich" ist so eine Sache. Man sollte überlegen, ob nicht mal irgendwann jemand sowas machen will wie

if (containsPiece(x)) // NUR wenn da was ist...
{
    setPiece(x,p); //... setz' ich da hin und schlage
}

Wenn es NUR "setPiece" gibt, ist das nicht möglich....

 

[Bleistift]

Stimmt ;-) Am besten man schreibt setPiece mit boolean-Rückgabe als eine Zusammenfassung der trotzdem noch vorhandenen Methoden containsPiece und setPiece, damit man beide Versionen benutzen kann.
mfg Bleistift