From ac0f6f6f3ea735eaf1b58b1ecb4974056a82642f Mon Sep 17 00:00:00 2001 From: FC Stegerman Date: Mon, 17 Jul 2023 20:35:02 +0200 Subject: [PATCH] Utils.getRenamedCardImageFileName(): add javadoc Co-authored-by: Sylvia van Os --- app/src/main/java/protect/card_locker/Utils.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/app/src/main/java/protect/card_locker/Utils.java b/app/src/main/java/protect/card_locker/Utils.java index dd634489a..f5d28455b 100644 --- a/app/src/main/java/protect/card_locker/Utils.java +++ b/app/src/main/java/protect/card_locker/Utils.java @@ -386,6 +386,13 @@ public class Utils { return cardImageFileNameBuilder.toString(); } + /** + * Returns a card image filename (string) with the ID replaced according to the map if the input is a valid card image filename (string), otherwise null. + * + * @param fileName e.g. "card_1_front.png" + * @param idMap e.g. Map.of(1, 2) + * @return String e.g. "card_2_front.png" + */ static public String getRenamedCardImageFileName(final String fileName, final Map idMap) { Pattern pattern = Pattern.compile(CARD_IMAGE_FILENAME_REGEX); Matcher matcher = pattern.matcher(fileName);