From 792944a7ceaaa522360e0c8a4af6d99952914dc1 Mon Sep 17 00:00:00 2001 From: Leonardo Brandenberger Date: Fri, 10 Dec 2021 10:46:48 +0100 Subject: [PATCH] Finished Class Field (Cleanup and Javadoc) --- src/ch/zhaw/catan/Field.java | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/ch/zhaw/catan/Field.java b/src/ch/zhaw/catan/Field.java index 9d43114..24735e3 100644 --- a/src/ch/zhaw/catan/Field.java +++ b/src/ch/zhaw/catan/Field.java @@ -2,24 +2,50 @@ package ch.zhaw.catan; import ch.zhaw.hexboard.Label; +/** + * Field Class stores Land and Label in Corresponding Field. + * + * @author Roman Schenk + */ public class Field { private final Config.Land land; private final Label label; + /** + * Constructs field object that stores land and label object in Field. + * + * @param land that will be stored in Field + * @param label that will be stored in Field + */ public Field(Config.Land land, Label label) { this.land = land; this.label = label; } + /** + * Returns the Resource type of the field. + * + * @return Config.Resource of the field + */ public Config.Resource getResource() { return land.getResource(); } + /** + * Return the Land type of the field. + * + * @return Config.Land of the field + */ public Config.Land getLand() { return land; } + /** + * Return the label of the field. + * + * @return Label of the field + */ public Label getLabel() { return label; }