From fa8fd8f0eb63198da62b853bab12cc416bc3aee4 Mon Sep 17 00:00:00 2001 From: Stefan Suhren Date: Mon, 30 Nov 2015 17:07:36 +0100 Subject: Add default header for methods and classes --- src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java | 56 ++++++++++++++ .../in/inf/se/notepadMinusMinus/model/Grade.java | 85 ++++++++++++++++++++++ .../in/inf/se/notepadMinusMinus/model/Grades.java | 46 ++++++++++++ .../notepadMinusMinus/view/MainViewController.java | 43 +++++++++++ 4 files changed, 230 insertions(+) (limited to 'src/de/fhswf/in/inf') diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java index e9e2af5..3a72d6b 100644 --- a/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java +++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/Main.java @@ -20,6 +20,12 @@ import javafx.scene.control.Alert.AlertType; import javafx.scene.layout.BorderPane; import javafx.stage.Stage; +/** + * TODO Add comment here + * + * @author $Author: $ + * @version $Revision: $, $Date: $ UTC + */ public class Main extends Application { private ObservableList gradeList = FXCollections @@ -29,6 +35,11 @@ public class Main extends Application private File openFile; + /* + * (non-Javadoc) + * + * @see javafx.application.Application#start(javafx.stage.Stage) + */ @Override public void start(Stage primaryStage) { @@ -55,31 +66,61 @@ public class Main extends Application } } + /** + * TODO Add method comment here + * + * @param args + */ public static void main(String[] args) { launch(args); } + /** + * TODO Add method comment here + * + * @return + */ public ObservableList getGradeList() { return gradeList; } + /** + * TODO Add method comment here + * + * @return + */ public Stage getPrimaryStage() { return primaryStage; } + /** + * TODO Add method comment here + * + * @return + */ public File getOpenFile() { return openFile; } + /** + * TODO Add method comment here + * + * @param openFile + */ public void setOpenFile(File openFile) { this.openFile = openFile; } + /** + * TODO Add method comment here + * + * @return + */ public File getGradesFilePath() { Preferences prefs = Preferences.userNodeForPackage(Main.class); @@ -94,6 +135,11 @@ public class Main extends Application } } + /** + * TODO Add method comment here + * + * @param file + */ public void setGradesFilePath(File file) { Preferences prefs = Preferences.userNodeForPackage(Main.class); @@ -113,6 +159,11 @@ public class Main extends Application } } + /** + * TODO Add method comment here + * + * @param file + */ public void loadGradesFromFile(File file) { try @@ -146,6 +197,11 @@ public class Main extends Application } } + /** + * TODO Add method comment here + * + * @param file + */ public void saveGradesToFile(File file) { try diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java index 77310c7..9758e6a 100644 --- a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java +++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java @@ -43,6 +43,11 @@ public class Grade private IntegerProperty attempt = new SimpleIntegerProperty(1); + /** + * TODO Add method comment here + * + * @return + */ public static Callback extractor() { return (Grade grade) -> new Observable[] { grade.semesterProperty(), @@ -50,86 +55,166 @@ public class Grade grade.gradeProperty(), grade.attemptProperty() }; } + /** + * TODO Add method comment here + * + * @return + */ public final IntegerProperty semesterProperty() { return this.semester; } + /** + * TODO Add method comment here + * + * @return + */ @XmlAttribute(name = "semester") public final int getSemester() { return this.semesterProperty().get(); } + /** + * TODO Add method comment here + * + * @param semester + */ public final void setSemester(final int semester) { this.semesterProperty().set(semester); } + /** + * TODO Add method comment here + * + * @return + */ public final StringProperty modulenameProperty() { return this.modulename; } + /** + * TODO Add method comment here + * + * @return + */ @XmlAttribute(name = "modulename", required = true) public final String getModulename() { return this.modulenameProperty().get(); } + /** + * TODO Add method comment here + * + * @param modulename + */ public final void setModulename(final java.lang.String modulename) { this.modulenameProperty().set(modulename); } + /** + * TODO Add method comment here + * + * @return + */ public final IntegerProperty ectsProperty() { return this.ects; } + /** + * TODO Add method comment here + * + * @return + */ @XmlAttribute(name = "ects") public final int getEcts() { return this.ectsProperty().get(); } + /** + * TODO Add method comment here + * + * @param ects + */ public final void setEcts(final int ects) { this.ectsProperty().set(ects); } + /** + * TODO Add method comment here + * + * @return + */ public final ObjectProperty gradeProperty() { return this.grade; } + /** + * TODO Add method comment here + * + * @return + */ @XmlValue public final BigDecimal getGrade() { return this.gradeProperty().get(); } + /** + * TODO Add method comment here + * + * @param grade + */ public final void setGrade(final BigDecimal grade) { this.gradeProperty().set(grade); } + /** + * TODO Add method comment here + * + * @return + */ public final IntegerProperty attemptProperty() { return this.attempt; } + /** + * TODO Add method comment here + * + * @return + */ @XmlAttribute(name = "attempt") public final int getAttempt() { return this.attemptProperty().get(); } + /** + * TODO Add method comment here + * + * @param attempt + */ public final void setAttempt(final int attempt) { this.attemptProperty().set(attempt); } + /** + * TODO Add method comment here + * + * @return + */ public static final ObservableList gradeValuesProperty() { if (gradeValues == null) diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java index dda5db8..631097e 100644 --- a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java +++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java @@ -11,6 +11,12 @@ import javax.xml.bind.annotation.XmlRootElement; import javafx.beans.property.ObjectProperty; import javafx.beans.property.SimpleObjectProperty; +/** + * TODO Add comment here + * + * @author $Author: $ + * @version $Revision: $, $Date: $ UTC + */ @XmlRootElement(name = "grades") public class Grades { @@ -22,6 +28,11 @@ public class Grades private ObjectProperty colloquium = new SimpleObjectProperty<>( new BigDecimal("0.0")); + /** + * TODO Add method comment here + * + * @return + */ @XmlElement(name = "grade", required = true) public List getGrades() { @@ -32,38 +43,73 @@ public class Grades return this.grades; } + /** + * TODO Add method comment here + * + * @param consumption + */ public void setGrades(List consumption) { this.grades = consumption; } + /** + * TODO Add method comment here + * + * @return + */ public final ObjectProperty thesisProperty() { return this.thesis; } + /** + * TODO Add method comment here + * + * @return + */ @XmlAttribute(name = "thesis") public final BigDecimal getThesis() { return this.thesisProperty().get(); } + /** + * TODO Add method comment here + * + * @param thesis + */ public final void setThesis(final BigDecimal thesis) { this.thesisProperty().set(thesis); } + /** + * TODO Add method comment here + * + * @return + */ public final ObjectProperty colloquiumProperty() { return this.colloquium; } + /** + * TODO Add method comment here + * + * @return + */ @XmlAttribute(name = "colloquium") public final BigDecimal getColloquium() { return this.colloquiumProperty().get(); } + /** + * TODO Add method comment here + * + * @param colloquium + */ public final void setColloquium(final BigDecimal colloquium) { this.colloquiumProperty().set(colloquium); diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/view/MainViewController.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/view/MainViewController.java index ef15ebd..fed6d36 100644 --- a/src/de/fhswf/in/inf/se/notepadMinusMinus/view/MainViewController.java +++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/view/MainViewController.java @@ -19,6 +19,12 @@ import javafx.scene.control.cell.TextFieldTableCell; import javafx.stage.FileChooser; import javafx.util.converter.IntegerStringConverter; +/** + * TODO Add comment here + * + * @author $Author: $ + * @version $Revision: $, $Date: $ UTC + */ public class MainViewController { @FXML @@ -56,6 +62,10 @@ public class MainViewController private Main main; + /** + * TODO Add method comment here + * + */ @FXML private void initialize() { @@ -105,6 +115,11 @@ public class MainViewController colloquiumComboBox.setItems(Grade.gradeValuesProperty()); } + /** + * TODO Add method comment here + * + * @param main + */ public void setMain(Main main) { this.main = main; @@ -134,6 +149,10 @@ public class MainViewController }); } + /** + * TODO Add method comment here + * + */ @FXML private void handleNewValue() { @@ -141,6 +160,10 @@ public class MainViewController gradeTable.getItems().add(grade); } + /** + * TODO Add method comment here + * + */ @FXML private void handleDeleteValue() { @@ -152,6 +175,10 @@ public class MainViewController } } + /** + * TODO Add method comment here + * + */ @FXML private void handleNew() { @@ -162,6 +189,10 @@ public class MainViewController } } + /** + * TODO Add method comment here + * + */ @FXML private void handleOpen() { @@ -194,6 +225,10 @@ public class MainViewController } } + /** + * TODO Add method comment here + * + */ @FXML private void handleSave() { @@ -210,6 +245,10 @@ public class MainViewController } } + /** + * TODO Add method comment here + * + */ @FXML private void handleSaveAs() { @@ -246,6 +285,10 @@ public class MainViewController } } + /** + * TODO Add method comment here + * + */ @FXML private void handleExit() { -- cgit v1.2.3-70-g09d2