diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..fcc67e7 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "shengchen.vscode-checkstyle" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index 1133129..a694c91 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,3 +1,4 @@ { - "java.configuration.updateBuildConfiguration": "automatic" + "java.configuration.updateBuildConfiguration": "automatic", + "java.checkstyle.configuration": "${workspaceFolder}\\flashy\\checkstyle.xml" } \ No newline at end of file diff --git a/flashy/checkstyle.xml b/flashy/checkstyle.xml new file mode 100644 index 0000000..3d47f31 --- /dev/null +++ b/flashy/checkstyle.xml @@ -0,0 +1,317 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/domainlogic/FlashcardProvider.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/domainlogic/FlashcardProvider.java index ff9f9fc..7ec04aa 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/domainlogic/FlashcardProvider.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/domainlogic/FlashcardProvider.java @@ -1,19 +1,20 @@ package it1901.groups2021.gr2141.core.domainlogic; -import java.util.List; -import java.util.Random; -import java.util.prefs.Preferences; - import it1901.groups2021.gr2141.core.models.CardContent; import it1901.groups2021.gr2141.core.models.CardDeck; import it1901.groups2021.gr2141.core.state.Observable; - +import java.util.List; +import java.util.Random; +import java.util.prefs.Preferences; /** - * A class handling card navigation from a CardDeck + * A class handling card navigation from a CardDeck. */ + public class FlashcardProvider extends Observable { - private static final Preferences prefs = Preferences.userRoot().node(FlashcardProvider.class.getName()); + private static final Preferences preferences = Preferences.userRoot() + .node(FlashcardProvider + .class.getName()); private CardDeck deck; private int cardIndex; @@ -26,16 +27,16 @@ public class FlashcardProvider extends Observable { /** * Default constructor. * - * @param deck the initial carddeck to register to the provider. + * @param deck the initial cardDeck to register to the provider. */ public FlashcardProvider(CardDeck deck) { this.setCardDeck(deck); this.cardIndex = 0; this.cardShowsFront = true; - this.showOrderIsFlippedMode = prefs.getBoolean("showOrderIsFlippedMode", false); - this.cardOrderIsRandomMode = prefs.getBoolean("cardOrderIsRandomMode", false); - this.firstLastWrapAroundMode = prefs.getBoolean("firstLastWrapAroundMode", true); + this.showOrderIsFlippedMode = preferences.getBoolean("showOrderIsFlippedMode", false); + this.cardOrderIsRandomMode = preferences.getBoolean("cardOrderIsRandomMode", false); + this.firstLastWrapAroundMode = preferences.getBoolean("firstLastWrapAroundMode", true); } private void updateSubscribers() { @@ -104,22 +105,13 @@ public class FlashcardProvider extends Observable { this.cardIndex = cardIndex; - if (firstLastWrapAroundMode) + if (firstLastWrapAroundMode) { this.cardIndex = Math.floorMod(this.cardIndex, this.deck.getNumberOfCards()); - + } cardShowsFront = true; updateSubscribers(); } - // used for later iterations - // public void turnToFirstCard() { - // turnToCard(0); - // } - - // public void turnToLastCard() { - // turnToCard(this.deck.getNumberOfCards() - 1); - // } - /** * Turn to the next card in the stack. * @@ -190,7 +182,7 @@ public class FlashcardProvider extends Observable { */ public void toggleShowOrderIsFlippedMode() { this.showOrderIsFlippedMode = !this.showOrderIsFlippedMode; - prefs.putBoolean("showOrderIsFlippedMode", this.showOrderIsFlippedMode); + preferences.putBoolean("showOrderIsFlippedMode", this.showOrderIsFlippedMode); updateSubscribers(); } @@ -201,7 +193,7 @@ public class FlashcardProvider extends Observable { */ public void toggleCardOrderIsRandomMode() { this.cardOrderIsRandomMode = !this.cardOrderIsRandomMode; - prefs.putBoolean("cardOrderIsRandomMode", this.cardOrderIsRandomMode); + preferences.putBoolean("cardOrderIsRandomMode", this.cardOrderIsRandomMode); updateSubscribers(); } @@ -212,7 +204,7 @@ public class FlashcardProvider extends Observable { */ public void toggleFirstLastWrapAroundMode() { this.firstLastWrapAroundMode = !this.firstLastWrapAroundMode; - prefs.putBoolean("firstLastWrapAroundMode", this.firstLastWrapAroundMode); + preferences.putBoolean("firstLastWrapAroundMode", this.firstLastWrapAroundMode); updateSubscribers(); } @@ -234,6 +226,6 @@ public class FlashcardProvider extends Observable { "showOrderIsFlippedMode", "cardOrderIsRandomMode", "firstLastWrapAroundMode" - ).forEach(prefs::remove); + ).forEach(preferences::remove); } } diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardContent.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardContent.java index eadb7c4..283a295 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardContent.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardContent.java @@ -5,7 +5,6 @@ import java.util.List; /** * Data model representing the content inside a {@link Flashcard Flashcard}. - * * Usually consist of one or more lines of text. */ public class CardContent { @@ -16,9 +15,9 @@ public class CardContent { * @param lines The lines of text. */ public CardContent(List lines) { - if (lines == null || lines.size() == 0) + if (lines == null || lines.size() == 0) { throw new IllegalArgumentException("Lines can not be null/empty"); - + } this.lines = lines; } @@ -27,17 +26,17 @@ public class CardContent { * @param text The lines of text. */ public CardContent(String text) { - if (text == null || text.length() == 0) + if (text == null || text.length() == 0) { throw new IllegalArgumentException("Text can not be null/empty"); - + } this.lines = Arrays.asList(text.split("\n")); } @Override public boolean equals(Object obj) { - if (!(obj instanceof CardContent)) + if (!(obj instanceof CardContent)) { return false; - + } return this.getLines().equals(((CardContent) obj).getLines()); } diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardDeck.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardDeck.java index 050f732..566a7ff 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardDeck.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/CardDeck.java @@ -1,33 +1,32 @@ package it1901.groups2021.gr2141.core.models; +import it1901.groups2021.gr2141.core.state.Observable; import java.util.ArrayList; import java.util.List; import java.util.stream.Collectors; - -import it1901.groups2021.gr2141.core.state.Observable; - /** * Data model representing a deck/collection of {@link Flashcard Flashcard}s. */ + public class CardDeck extends Observable { private List flashcards; /** - * Create an empty new instance + * Create an empty new instance. */ public CardDeck() { this.flashcards = new ArrayList<>(); } /** - * Create an instance from a list of {@link Flashcard Flashcard}s + * Create an instance from a list of {@link Flashcard Flashcards}. * * @param flashcards A list of {@link Flashcard Flashcard} instances */ public CardDeck(List flashcards) { - if (flashcards == null) + if (flashcards == null) { throw new IllegalArgumentException("Flashcards can not be null"); - + } // By wrapping the cards into a new list, the list becomes mutable this.flashcards = new ArrayList<>(flashcards); } @@ -39,9 +38,9 @@ public class CardDeck extends Observable { @Override public boolean equals(Object obj) { - if (!(obj instanceof CardDeck)) + if (!(obj instanceof CardDeck)) { return false; - + } return this.getFlashcards().equals(((CardDeck) obj).getFlashcards()); } @@ -51,9 +50,8 @@ public class CardDeck extends Observable { @Override public String toString() { - return "{\n" + - String.join("\n", flashcards.stream().map((f) -> " " + f.toString()).collect(Collectors.toList())) + - "\n}"; + return "{\n" + String.join("\n", flashcards.stream().map((f) -> " " + + f.toString()).collect(Collectors.toList())) + "\n}"; } /** @@ -83,9 +81,9 @@ public class CardDeck extends Observable { * @param card The new flashcard to add. */ public void add(Flashcard card) { - if (card == null) + if (card == null) { throw new IllegalArgumentException("Flashcard can not be null"); - + } flashcards.add(card); updateSubscribers(); } @@ -98,11 +96,12 @@ public class CardDeck extends Observable { * @param card The new flashcard to add. */ public void add(int index, Flashcard card) { - if (card == null) + if (card == null) { throw new IllegalArgumentException("Flashcard can not be null"); - if (index < 0 || flashcards.size() < index) + } + if (index < 0 || flashcards.size() < index) { throw new IllegalArgumentException("Index is out of bounds"); - + } flashcards.add(index, card); updateSubscribers(); } @@ -115,12 +114,12 @@ public class CardDeck extends Observable { * @param card The updated flashcard. */ public void update(int index, Flashcard card) { - if (card == null) + if (card == null) { throw new IllegalArgumentException("Flashcard can not be null"); - - if (index < 0 || index > flashcards.size()) + } + if (index < 0 || index > flashcards.size()) { throw new IllegalArgumentException("Can not update card at index: " + index); - + } flashcards.remove(index); flashcards.add(index, card); updateSubscribers(); @@ -133,9 +132,9 @@ public class CardDeck extends Observable { * @param index The index of the card to remove */ public void remove(int index) { - if (index < 0 || index > flashcards.size()) + if (index < 0 || index > flashcards.size()) { throw new IllegalArgumentException("Can not remove card at index: " + index); - + } flashcards.remove(index); updateSubscribers(); } diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/Flashcard.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/Flashcard.java index 0632e3e..237adb7 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/Flashcard.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/Flashcard.java @@ -4,7 +4,6 @@ import java.util.List; /** * Data model representing a flashcard. - * * Has a frontside and a backside, which both consist of {@link CardContent CardContent}. */ public class Flashcard { @@ -12,20 +11,21 @@ public class Flashcard { private CardContent back; /** - * Default constructor to generate a new flashcard + * Default constructor to generate a new flashcard. * * @param front The front side of the card * @param back The back side of the card */ public Flashcard(CardContent front, CardContent back) { - if (front == null || back == null) + if (front == null || back == null) { throw new IllegalArgumentException("CardContent can not be null"); + } this.front = front; this.back = back; } /** - * A helping constructor to generate Flashcards from lines of text + * A helping constructor to generate Flashcards from lines of text. * * @param front The (text) lines on the front side of the card * @param back The (text) lines on the back side of the card @@ -35,25 +35,27 @@ public class Flashcard { */ public static Flashcard of(List front, List back) { if ( - front == null || - back == null || - front.stream().allMatch((e) -> e.equals("")) || - (back.stream().allMatch((e) -> e.equals(""))) - ) throw new IllegalArgumentException("Front and back can not be null"); + front == null + || back == null + || front.stream().allMatch((e) -> e.equals("")) + || (back.stream().allMatch((e) -> e.equals(""))) + ) { + throw new IllegalArgumentException("Front and back can not be null"); + } return new Flashcard(new CardContent(front), new CardContent(back)); } /** - * A helping constructor to generate Flashcards from strings + * A helping constructor to generate Flashcards from strings. * * @param front The text on the front side of the card * @param back The text on the back side of the card * @return A new flashcard */ public static Flashcard of(String front, String back) { - if (front == null || back == null) + if (front == null || back == null) { throw new IllegalArgumentException("Front and back can not be null"); - + } return new Flashcard(new CardContent(front), new CardContent(back)); } @@ -64,16 +66,17 @@ public class Flashcard { @Override public boolean equals(Object obj) { - if (!(obj instanceof Flashcard)) + if (!(obj instanceof Flashcard)) { return false; - + } Flashcard card2 = (Flashcard) obj; return this.getFront().equals(card2.getFront()) && this.getBack().equals(card2.getBack()); } @Override public String toString() { - return "[" + String.join("/", this.front.getLines()) + "] [" + String.join("/", this.back.getLines()) + "]"; + return "[" + String.join("/", this.front.getLines()) + + "] [" + String.join("/", this.back.getLines()) + "]"; } /** diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/package-info.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/package-info.java index 36fb36a..6a9199e 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/package-info.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/package-info.java @@ -1,4 +1,4 @@ /** - * Data models used within the application to represent real life constructs + * Data models used within the application to represent real life constructs. */ package it1901.groups2021.gr2141.core.models; \ No newline at end of file diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentDeserializer.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentDeserializer.java index bfe8ae4..e6ecf22 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentDeserializer.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentDeserializer.java @@ -1,33 +1,31 @@ package it1901.groups2021.gr2141.core.models.serializers; -import it1901.groups2021.gr2141.core.models.CardContent; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - import com.fasterxml.jackson.core.JacksonException; import com.fasterxml.jackson.core.JsonParser; import com.fasterxml.jackson.databind.DeserializationContext; -import com.fasterxml.jackson.databind.deser.std.StdDeserializer; import com.fasterxml.jackson.databind.JsonNode; - +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import it1901.groups2021.gr2141.core.models.CardContent; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; /** - * Deserializer for {@link it1901.groups2021.gr2141.core.models.CardContent CardContent} + * Deserializer for {@link it1901.groups2021.gr2141.core.models.CardContent CardContent}. */ + public class CardContentDeserializer extends StdDeserializer { /** - * Constructor sets card content deserializer to null + * Constructor sets card content deserializer to null. */ public CardContentDeserializer() { this(null); } - /** - * Initialize super object - * @param t - */ + /** + * Initialize super object. + * @param t Deserialize object type. + */ public CardContentDeserializer(Class t) { super(t); } @@ -40,14 +38,14 @@ public class CardContentDeserializer extends StdDeserializer { } /** - * Deserialization logic + * Deserialization logic. */ CardContent deserialize(JsonNode node) { List lines = new ArrayList<>(); - for (JsonNode n : node.get("lines")) + for (JsonNode n : node.get("lines")) { lines.add(n.asText()); - + } return new CardContent(lines); } } diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentSerializer.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentSerializer.java index 8e96549..1444784 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentSerializer.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardContentSerializer.java @@ -1,40 +1,46 @@ package it1901.groups2021.gr2141.core.models.serializers; -import it1901.groups2021.gr2141.core.models.CardContent; -import java.io.IOException; - import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.ser.std.StdSerializer; - +import it1901.groups2021.gr2141.core.models.CardContent; +import java.io.IOException; /** - * Serializer for {@link it1901.groups2021.gr2141.core.models.CardContent CardContent} + * Serializer for {@link it1901.groups2021.gr2141.core.models.CardContent CardContent}. */ + public class CardContentSerializer extends StdSerializer { + /** - * Constructor sets card content serializer to null + * Constructor sets card content serializer to null. */ public CardContentSerializer() { this(null); } - /** - * Initialize super object - * @param t - */ + /** + * Initialize super object. + * @param t Serialize object type. + */ public CardContentSerializer(Class t) { super(t); } @Override - public void serialize(CardContent cardContent, JsonGenerator jgenerator, SerializerProvider provider) - throws IOException { + public void serialize(CardContent cardContent, + JsonGenerator jgenerator, + SerializerProvider provider) + throws IOException { + jgenerator.writeStartObject(); jgenerator.writeFieldName("lines"); jgenerator.writeStartArray(); - for (String line : cardContent.getLines()) + + for (String line : cardContent.getLines()) { jgenerator.writeString(line); + } + jgenerator.writeEndArray(); jgenerator.writeEndObject(); diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckDeserializer.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckDeserializer.java index f4ca8cc..d34ab92 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckDeserializer.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckDeserializer.java @@ -1,21 +1,19 @@ package it1901.groups2021.gr2141.core.models.serializers; -import it1901.groups2021.gr2141.core.models.CardDeck; -import it1901.groups2021.gr2141.core.models.Flashcard; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - import com.fasterxml.jackson.core.JacksonException; import com.fasterxml.jackson.core.JsonParser; import com.fasterxml.jackson.databind.DeserializationContext; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.deser.std.StdDeserializer; - +import it1901.groups2021.gr2141.core.models.CardDeck; +import it1901.groups2021.gr2141.core.models.Flashcard; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; /** - * Deserializer for {@link it1901.groups2021.gr2141.core.models.CardDeck CardDeck} + * Deserializer for {@link it1901.groups2021.gr2141.core.models.CardDeck CardDeck}. */ + public class CardDeckDeserializer extends StdDeserializer { private FlashcardDeserializer flashcardDeserializer = new FlashcardDeserializer(); @@ -27,29 +25,32 @@ public class CardDeckDeserializer extends StdDeserializer { this(null); } - /** - * Initialize super object - * @param t - */ + /** + * Initialize super object. + * @param t Deserialize object type. + */ public CardDeckDeserializer(Class t) { super(t); } @Override - public CardDeck deserialize(JsonParser jparser, DeserializationContext context) throws IOException, JacksonException { + public CardDeck deserialize(JsonParser jparser, + DeserializationContext context) + throws IOException, JacksonException { + JsonNode node = jparser.getCodec().readTree(jparser); return deserialize(node); } /** - * Deserialization logic + * Deserialization logic. */ CardDeck deserialize(JsonNode node) { List cards = new ArrayList<>(); - for (JsonNode n : node.get("flashcards")) + for (JsonNode n : node.get("flashcards")) { cards.add(flashcardDeserializer.deserialize(n)); - + } return new CardDeck(cards); } } \ No newline at end of file diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckSerializer.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckSerializer.java index 9465d40..8e2cfc1 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckSerializer.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/CardDeckSerializer.java @@ -1,40 +1,44 @@ package it1901.groups2021.gr2141.core.models.serializers; -import it1901.groups2021.gr2141.core.models.CardDeck; - -import java.io.IOException; - import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.ser.std.StdSerializer; - +import it1901.groups2021.gr2141.core.models.CardDeck; +import java.io.IOException; /** - * Serializer for {@link it1901.groups2021.gr2141.core.models.CardDeck CardDeck} + * Serializer for {@link it1901.groups2021.gr2141.core.models.CardDeck CardDeck}. */ + public class CardDeckSerializer extends StdSerializer { /** - * Constructor sets card deck serializer to null + * Constructor sets card deck serializer to null. */ public CardDeckSerializer() { this(null); } - /** - * Initialize super object - * @param t + /** + * Initialize super object. + * @param t Serialize object type. */ public CardDeckSerializer(Class t) { super(t); } @Override - public void serialize(CardDeck cardDeck, JsonGenerator jgenerator, SerializerProvider provider) throws IOException { + public void serialize(CardDeck cardDeck, + JsonGenerator jgenerator, + SerializerProvider provider) + throws IOException { + jgenerator.writeStartObject(); jgenerator.writeFieldName("flashcards"); jgenerator.writeStartArray(); - for (var flashcard : cardDeck.getFlashcards()) + + for (var flashcard : cardDeck.getFlashcards()) { jgenerator.writeObject(flashcard); + } jgenerator.writeEndArray(); jgenerator.writeEndObject(); } diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardDeserializer.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardDeserializer.java index a6423f7..d1d61fa 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardDeserializer.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardDeserializer.java @@ -1,47 +1,48 @@ package it1901.groups2021.gr2141.core.models.serializers; -import it1901.groups2021.gr2141.core.models.Flashcard; -import it1901.groups2021.gr2141.core.models.CardContent; - -import java.io.IOException; - import com.fasterxml.jackson.core.JacksonException; import com.fasterxml.jackson.core.JsonParser; import com.fasterxml.jackson.databind.DeserializationContext; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.deser.std.StdDeserializer; - +import it1901.groups2021.gr2141.core.models.CardContent; +import it1901.groups2021.gr2141.core.models.Flashcard; +import java.io.IOException; /** - * Deserializer for {@link it1901.groups2021.gr2141.core.models.Flashcard Flashcard} + * Deserializer for {@link it1901.groups2021.gr2141.core.models.Flashcard Flashcard}. */ + public class FlashcardDeserializer extends StdDeserializer { private CardContentDeserializer cardContentDeserializer = new CardContentDeserializer(); /** - * Constructor sets flashcard deserializer to null + * Constructor sets flashcard deserializer to null. */ public FlashcardDeserializer() { this(null); } - /** + /** * Initialize super object - * @param t + * @param t Deserialize object type. */ public FlashcardDeserializer(Class t) { super(t); } @Override - public Flashcard deserialize(JsonParser jparser, DeserializationContext context) throws IOException, JacksonException { + public Flashcard deserialize(JsonParser jparser, + DeserializationContext context) + throws IOException, JacksonException { + JsonNode node = jparser.getCodec().readTree(jparser); return deserialize(node); } /** - * Deserialization logic + * Deserialization logic. */ Flashcard deserialize(JsonNode node) { CardContent front = cardContentDeserializer.deserialize(node.get("front")); diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardSerializer.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardSerializer.java index 0259a5f..e015f19 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardSerializer.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/FlashcardSerializer.java @@ -1,35 +1,37 @@ package it1901.groups2021.gr2141.core.models.serializers; -import it1901.groups2021.gr2141.core.models.Flashcard; - -import java.io.IOException; - import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.ser.std.StdSerializer; - +import it1901.groups2021.gr2141.core.models.Flashcard; +import java.io.IOException; /** - * Serializer for {@link it1901.groups2021.gr2141.core.models.Flashcard Flashcard} + * Serializer for {@link it1901.groups2021.gr2141.core.models.Flashcard Flashcard}. */ + public class FlashcardSerializer extends StdSerializer { /** - * Constructor sets flashcard serializer to null + * Constructor sets flashcard serializer to null. */ public FlashcardSerializer() { this(null); } - /** + /** * Initialize super object - * @param t + * @param t Serialize object type. */ public FlashcardSerializer(Class t) { super(t); } @Override - public void serialize(Flashcard flashcard, JsonGenerator jgenerator, SerializerProvider provider) throws IOException { + public void serialize(Flashcard flashcard, + JsonGenerator jgenerator, + SerializerProvider provider) + throws IOException { + jgenerator.writeStartObject(); jgenerator.writeFieldName("front"); jgenerator.writeObject(flashcard.getFront()); diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/ModelSerializingModule.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/ModelSerializingModule.java index 386a305..96c9e0c 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/ModelSerializingModule.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/models/serializers/ModelSerializingModule.java @@ -2,19 +2,19 @@ package it1901.groups2021.gr2141.core.models.serializers; import com.fasterxml.jackson.core.Version; import com.fasterxml.jackson.databind.module.SimpleModule; - import it1901.groups2021.gr2141.core.models.CardContent; import it1901.groups2021.gr2141.core.models.CardDeck; import it1901.groups2021.gr2141.core.models.Flashcard; /** - * Uses simple module from the jackson library, to serialize and deserialize data + * Uses simple module from the jackson library, to serialize and deserialize data. */ + public class ModelSerializingModule extends SimpleModule { private static final String NAME = "FlashcardModule"; /** - * Model that initializes serializing and deserializing + * Model that initializes serializing and deserializing. * */ public ModelSerializingModule() { diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/state/Observable.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/state/Observable.java index 17e61c7..45cf145 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/state/Observable.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/state/Observable.java @@ -1,14 +1,15 @@ package it1901.groups2021.gr2141.core.state; +import java.util.ArrayList; import java.util.Collection; import java.util.function.Consumer; -import java.util.ArrayList; - /** * A class that lets its subclasses execute a set of subscriber functions every * time something changes. */ + public abstract class Observable { + private Collection> subscribers = new ArrayList<>(); /** diff --git a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/storage/CardDeckStorage.java b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/storage/CardDeckStorage.java index 1eac404..b076837 100644 --- a/flashy/core/src/main/java/it1901/groups2021/gr2141/core/storage/CardDeckStorage.java +++ b/flashy/core/src/main/java/it1901/groups2021/gr2141/core/storage/CardDeckStorage.java @@ -1,24 +1,25 @@ package it1901.groups2021.gr2141.core.storage; -import java.io.IOException; -import java.io.File; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.List; -import java.util.ArrayList; -import java.util.Arrays; - import com.fasterxml.jackson.databind.ObjectMapper; - import it1901.groups2021.gr2141.core.models.CardDeck; import it1901.groups2021.gr2141.core.models.serializers.ModelSerializingModule; - +import java.io.File; +import java.io.IOException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; /** * A class which handles saving/loading - * {@link it1901.groups2021.gr2141.core.models.CardDeck CardDeck}s. + * {@link it1901.groups2021.gr2141.core.models.CardDeck CardDecks}. */ + public final class CardDeckStorage { - private static final ObjectMapper mapper = new ObjectMapper().registerModule(new ModelSerializingModule()); + + private static final ObjectMapper mapper + = new ObjectMapper().registerModule(new ModelSerializingModule()); + private static Path dataDirectory = getUserDataDirectory(); /** @@ -27,18 +28,24 @@ public final class CardDeckStorage { * @param dataDirectory The path to the new data directory. */ public static void setUserDataDirectory(Path dataDirectory) { - if (dataDirectory == null) + if (dataDirectory == null) { throw new IllegalArgumentException("dataDirectory can not be null"); - + } CardDeckStorage.dataDirectory = dataDirectory; - }; + } - private CardDeckStorage() {} + /** + * Constructor that prevents creating a new instance + * of CardDeckStorage. + */ + private CardDeckStorage() { + + } /** * @return Name of operating system */ - protected static String getOSName() { + protected static String getOsName() { return (System.getProperty("os.name")).toLowerCase(); } @@ -51,7 +58,7 @@ public final class CardDeckStorage { /** * @return Data directory for all UNIX-like systems. This is the default - * location according to the XDG-specification + * location according to the XDG-specification. * * @see specifications.freedesktop.org @@ -69,18 +76,18 @@ public final class CardDeckStorage { * @see #readDeck(int) */ public static Path getUserDataDirectory() { - String OS = getOSName(); + String os = getOsName(); Path dataDir; - if (OS.contains("win")) + if (os.contains("win")) { dataDir = getWindowsDataRootPath(); - else + } else { dataDir = getUnixDataRootPath(); - + } dataDir = dataDir.resolve("flashy"); - if (!dataDir.toFile().exists()) + if (!dataDir.toFile().exists()) { dataDir.toFile().mkdirs(); - + } return dataDir; } @@ -98,16 +105,17 @@ public final class CardDeckStorage { private static int getNextDeckID() { var i = 0; - while (dataDirectory.resolve("deck-" + i + ".json").toFile().exists()) + while (dataDirectory.resolve("deck-" + i + ".json").toFile().exists()) { i++; + } return i; } /** - * Write a card deck to the next available id + * Write a card deck to the next available id. * - * @param deck - * @throws IOException if deck is not found + * @param deck the CardDeck. + * @throws IOException if deck is not found. */ public static void writeDeck(CardDeck deck) throws IOException { writeDeck(deck, getNextDeckID()); @@ -117,21 +125,21 @@ public final class CardDeckStorage { * Write a card deck with a specified. This will overwrite the deck already * saved, if it exists. * - * @param deck The deck to be saved + * @param deck The deck to be saved. * @param id The id to write the deck to. * @see #writeDeckToFile(File, CardDeck) * @throws IOException if deck is not found * @throws IllegalArgumentException when id is less than 0 */ public static void writeDeck(CardDeck deck, int id) throws IOException { - if (id < 0) + if (id < 0) { throw new IllegalArgumentException("ID can not be negative!"); - + } File file = dataDirectory.resolve("deck-" + Integer.toString(id) + ".json").toFile(); - if (!file.exists()) + if (!file.exists()) { file.createNewFile(); - + } writeDeckToFile(file, deck); } @@ -151,7 +159,7 @@ public final class CardDeckStorage { * Reads all saved CardDecks. * * @see #readDeck(int) - * @return A list of all the CardDecks on disk. + * @return A list of all the CardDecks on disk * @throws IOException if deck is not found */ public static List readAllDecks() throws IOException { diff --git a/flashy/core/src/test/java/it1901/groups2021/gr2141/core/storage/CardDeckStorageTest.java b/flashy/core/src/test/java/it1901/groups2021/gr2141/core/storage/CardDeckStorageTest.java index c090bb5..7f17acd 100644 --- a/flashy/core/src/test/java/it1901/groups2021/gr2141/core/storage/CardDeckStorageTest.java +++ b/flashy/core/src/test/java/it1901/groups2021/gr2141/core/storage/CardDeckStorageTest.java @@ -51,10 +51,10 @@ public class CardDeckStorageTest { cdsMock.when(() -> CardDeckStorage.getWindowsDataRootPath()).thenReturn(tempDir.toPath()); cdsMock.when(() -> CardDeckStorage.getUnixDataRootPath()).thenReturn(tempDir.toPath().resolve("anotherFolder")); - cdsMock.when(() -> CardDeckStorage.getOSName()).thenReturn("win-10"); + cdsMock.when(() -> CardDeckStorage.getOsName()).thenReturn("win-10"); assertEquals(tempDir.toPath().resolve("flashy"), CardDeckStorage.getUserDataDirectory()); - cdsMock.when(() -> CardDeckStorage.getOSName()).thenReturn("linux"); + cdsMock.when(() -> CardDeckStorage.getOsName()).thenReturn("linux"); assertEquals(tempDir.toPath().resolve("anotherFolder/flashy"), CardDeckStorage.getUserDataDirectory()); } } diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppController.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppController.java index cd25f3d..c5db6e1 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppController.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppController.java @@ -1,16 +1,15 @@ package it1901.groups2021.gr2141.ui; +import it1901.groups2021.gr2141.core.storage.CardDeckStorage; +import it1901.groups2021.gr2141.ui.controllers.Controller; import java.io.IOException; import java.net.URL; import java.util.ResourceBundle; - -import it1901.groups2021.gr2141.core.storage.CardDeckStorage; import javafx.fxml.Initializable; -import it1901.groups2021.gr2141.ui.controllers.Controller; - /** - * Root UI controller + * Root UI controller. */ + public class AppController extends Controller implements Initializable { private static void setupStorageListener() { diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppState.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppState.java index 1134c64..4b74aa3 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppState.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/AppState.java @@ -1,21 +1,26 @@ package it1901.groups2021.gr2141.ui; -import java.io.IOException; -import java.util.List; - import it1901.groups2021.gr2141.core.domainlogic.FlashcardProvider; import it1901.groups2021.gr2141.core.models.CardDeck; import it1901.groups2021.gr2141.core.models.Flashcard; import it1901.groups2021.gr2141.core.storage.CardDeckStorage; - +import java.io.IOException; +import java.util.List; /** * A singleton containing the state of the whole application. */ + public final class AppState { private static FlashcardProvider flashCardProvider; - private AppState() {} + /** + * Constructor that prevents creating a new instance + * of AppState. + */ + private AppState() { + + } /** * Initialize the FlashcardProvider with default values. diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/Flashy.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/Flashy.java index 22585d2..aad6d17 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/Flashy.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/Flashy.java @@ -1,22 +1,23 @@ package it1901.groups2021.gr2141.ui; -import javafx.application.Application; -import javafx.stage.Stage; import java.io.IOException; - +import javafx.application.Application; import javafx.fxml.FXMLLoader; import javafx.scene.Parent; import javafx.scene.Scene; import javafx.scene.image.Image; +import javafx.stage.Stage; /** * Root of the application. */ + public class Flashy extends Application { - + /** * Starting the application - * @param args + * + * @param args Command line arguments. */ public static void main(String[] args) { launch(args); @@ -30,7 +31,8 @@ public class Flashy extends Application { Parent parent = fxmlLoader.load(); Scene scene = new Scene(parent); - stage.getIcons().add(new Image(getClass().getResourceAsStream("/it1901/groups2021/gr2141/ui/graphics/logo.png"))); + stage.getIcons().add(new Image(getClass() + .getResourceAsStream("/it1901/groups2021/gr2141/ui/graphics/logo.png"))); scene.getStylesheets().add(getClass().getResource("styling/Flashy.css").toExternalForm()); stage.setTitle("Flashy!"); stage.setScene(scene); diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardAreaController.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardAreaController.java index 025bf04..da4101e 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardAreaController.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardAreaController.java @@ -1,17 +1,15 @@ package it1901.groups2021.gr2141.ui.controllers; import java.net.URL; -import java.util.List; import java.util.ResourceBundle; -import javafx.fxml.Initializable; - import javafx.fxml.FXML; +import javafx.fxml.Initializable; import javafx.scene.control.Label; import javafx.scene.input.MouseEvent; - /** * CardArea controller of the application UI. */ + public class CardAreaController extends Controller implements Initializable { @FXML @@ -23,7 +21,7 @@ public class CardAreaController extends Controller implements Initializable { getFlashcardProvider().subscribe((newFlashCardModel) -> showCurrentCardContent()); } - /** + /** * Updates the card shown in the UI */ public void showCurrentCardContent() { @@ -34,7 +32,7 @@ public class CardAreaController extends Controller implements Initializable { /** * Flips the card. This is connected to an FXML element. * - * @param event + * @param event a MouseEvent. */ @FXML public void handleFlipCardMouse(MouseEvent event) { diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardNavigationController.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardNavigationController.java index fbd4ee0..9fcc440 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardNavigationController.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/CardNavigationController.java @@ -11,7 +11,7 @@ public class CardNavigationController extends Controller { /** * Flips the card by pressing the button. * - * @param event + * @param event an ActionEvent. */ @FXML public void handleFlipCardButton(ActionEvent event) { @@ -21,24 +21,28 @@ public class CardNavigationController extends Controller { /** * Turns to the next card in the deck. * - * @param event + * @param event an ActionEvent. */ @FXML public void handleTurnToNextCard(ActionEvent event) { try { getFlashcardProvider().turnToNextCard(); - } catch (IllegalArgumentException e) {} + } catch (IllegalArgumentException e) { + System.out.println("You are on the last card!"); + } } /** * Turns to the previous card in the deck. * - * @param event + * @param event an ActionEvent. */ @FXML public void handleTurnToPreviousCard(ActionEvent event) { try { getFlashcardProvider().turnToPreviousCard(); - } catch (IllegalArgumentException e) {} + } catch (IllegalArgumentException e) { + System.out.println("You are on the first card!"); + } } } diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/MenuController.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/MenuController.java index 7452353..d43f0a4 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/MenuController.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/MenuController.java @@ -1,13 +1,13 @@ package it1901.groups2021.gr2141.ui.controllers; import it1901.groups2021.gr2141.core.models.Flashcard; +import javafx.event.ActionEvent; import javafx.fxml.FXML; import javafx.scene.control.TextField; -import javafx.event.ActionEvent; - /** * Menu controller of the application UI. */ + public class MenuController extends Controller { @FXML @@ -19,14 +19,15 @@ public class MenuController extends Controller { /** * Creates a new card and adds it to the active deck. * - * @param event + * @param event an ActionEvent. */ @FXML public void handleCreateFlashCard(ActionEvent event) { - if (writeFront.getText().isEmpty() || writeBack.getText().isEmpty()) + if (writeFront.getText().isEmpty() || writeBack.getText().isEmpty()) { return; - - getFlashcardProvider().getCardDeck().add(Flashcard.of(writeFront.getText(), writeBack.getText())); + } + getFlashcardProvider().getCardDeck() + .add(Flashcard.of(writeFront.getText(), writeBack.getText())); clearTextFields(); } diff --git a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/NavbarController.java b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/NavbarController.java index ed999ae..66897e4 100644 --- a/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/NavbarController.java +++ b/flashy/fxui/src/main/java/it1901/groups2021/gr2141/ui/controllers/NavbarController.java @@ -2,16 +2,14 @@ package it1901.groups2021.gr2141.ui.controllers; import java.net.URL; import java.util.ResourceBundle; - -import javafx.fxml.Initializable; - -import javafx.fxml.FXML; -import javafx.scene.control.ToggleButton; import javafx.event.ActionEvent; - +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.ToggleButton; /** * Navbar controller of the application UI. */ + public class NavbarController extends Controller implements Initializable { @FXML @@ -31,30 +29,33 @@ public class NavbarController extends Controller implements Initializable { private void setToggleButtonValues() { btnToggleRandomMode.setSelected(getFlashcardProvider().isCardOrderIsRandomMode()); btnToggleShowOtherSide.setSelected(getFlashcardProvider().isShowOrderIsFlippedMode()); - btnToggleFirstLastWrapAroundMode.setSelected(getFlashcardProvider().isFirstLastWrapAroundMode()); + btnToggleFirstLastWrapAroundMode.setSelected(getFlashcardProvider() + .isFirstLastWrapAroundMode()); } - /** + /** * @see it1901.groups2021.gr2141.core.domainlogic.FlashcardProvider#isShowOrderIsFlippedMode - * @param event + * @param event an ActionEvent. */ @FXML public void handleToggleShowOtherSide(ActionEvent event) { getFlashcardProvider().toggleShowOrderIsFlippedMode(); } - /** - * @see it1901.groups2021.gr2141.core.domainlogic.FlashcardProvider#isCardOrderIsRandomMode for more details. - * @param event + /** + * @see it1901.groups2021.gr2141.core.domainlogic.FlashcardProvider#isCardOrderIsRandomMode + * for more details. + * @param event an ActionEvent. */ @FXML public void handleToggleCardOrderIsRandom(ActionEvent event) { getFlashcardProvider().toggleCardOrderIsRandomMode(); } - /** - * @see it1901.groups2021.gr2141.core.domainlogic.FlashcardProvider#isFirstLastWrapAroundMode for more details. - * @param event + /** + * @see it1901.groups2021.gr2141.core.domainlogic.FlashcardProvider#isFirstLastWrapAroundMode + * for more details. + * @param event an ActionEvent. */ @FXML public void handleToggleFirstLastWrapAroundMode(ActionEvent event) { diff --git a/flashy/packaging/src/main/java/it1901/groups2021/gr2141/FlashyLauncher.java b/flashy/packaging/src/main/java/it1901/groups2021/gr2141/FlashyLauncher.java index 3ebddee..fb40f9f 100644 --- a/flashy/packaging/src/main/java/it1901/groups2021/gr2141/FlashyLauncher.java +++ b/flashy/packaging/src/main/java/it1901/groups2021/gr2141/FlashyLauncher.java @@ -5,12 +5,13 @@ import it1901.groups2021.gr2141.ui.Flashy; /** * A starting point of the application. */ + public class FlashyLauncher { /** * Should be used as the starting point when the application is packaged into a JAR file. * - * @param args + * @param args Command line arguments. */ public static void main(String[] args) { Flashy.main(args); diff --git a/flashy/pom.xml b/flashy/pom.xml index 832c099..8715733 100644 --- a/flashy/pom.xml +++ b/flashy/pom.xml @@ -234,6 +234,17 @@ + + org.apache.maven.plugins + maven-checkstyle-plugin + 3.1.2 + + checkstyle.xml + UTF-8 + true + + + @@ -285,7 +296,7 @@ maven-checkstyle-plugin 3.1.2 - google_checks.xml + checkstyle.xml UTF-8 true false