Usage Example:
+ *
+ * AtbashCipher cipher = new AtbashCipher("Hello World!");
+ * String encrypted = cipher.convert(); // Output: "Svool Dliow!"
+ *
+ *
+ * @author Krounosity
+ * @see Atbash Cipher (Wikipedia)
*/
-
public class AtbashCipher {
private String toConvert;
- // Default constructor.
- AtbashCipher() {
+ public AtbashCipher() {
}
- // String setting constructor.
- AtbashCipher(String str) {
- toConvert = str;
+ /**
+ * Constructor with a string parameter.
+ *
+ * @param str The string to be converted using the Atbash cipher
+ */
+ public AtbashCipher(String str) {
+ this.toConvert = str;
}
- // String getter method.
+ /**
+ * Returns the current string set for conversion.
+ *
+ * @return The string to be converted
+ */
public String getString() {
return toConvert;
}
- // String setter method.
+ /**
+ * Sets the string to be converted using the Atbash cipher.
+ *
+ * @param str The new string to convert
+ */
public void setString(String str) {
- toConvert = str;
+ this.toConvert = str;
}
- // Checking whether the current character is capital.
+ /**
+ * Checks if a character is uppercase.
+ *
+ * @param ch The character to check
+ * @return {@code true} if the character is uppercase, {@code false} otherwise
+ */
private boolean isCapital(char ch) {
return ch >= 'A' && ch <= 'Z';
}
- // Checking whether the current character is smallcased.
+ /**
+ * Checks if a character is lowercase.
+ *
+ * @param ch The character to check
+ * @return {@code true} if the character is lowercase, {@code false} otherwise
+ */
private boolean isSmall(char ch) {
return ch >= 'a' && ch <= 'z';
}
- // Converting text to atbash cipher code or vice versa.
+ /**
+ * Converts the input string using the Atbash cipher.
+ * Alphabetic characters are substituted with their opposite in the alphabet,
+ * while non-alphabetic characters remain unchanged.
+ *
+ * @return The converted string after applying the Atbash cipher
+ */
public String convert() {
-
- // Using StringBuilder to store new string.
StringBuilder convertedString = new StringBuilder();
- // Iterating for each character.
for (char ch : toConvert.toCharArray()) {
-
- // If the character is smallcased.
if (isSmall(ch)) {
convertedString.append((char) ('z' - (ch - 'a')));
- }
- // If the character is capital cased.
- else if (isCapital(ch)) {
+ } else if (isCapital(ch)) {
convertedString.append((char) ('Z' - (ch - 'A')));
- }
- // Non-alphabetical character.
- else {
+ } else {
convertedString.append(ch);
}
}
diff --git a/src/test/java/com/thealgorithms/ciphers/AtbashTest.java b/src/test/java/com/thealgorithms/ciphers/AtbashTest.java
index 26812cf2b..ec34bc26a 100644
--- a/src/test/java/com/thealgorithms/ciphers/AtbashTest.java
+++ b/src/test/java/com/thealgorithms/ciphers/AtbashTest.java
@@ -2,27 +2,42 @@ package com.thealgorithms.ciphers;
import static org.junit.jupiter.api.Assertions.assertEquals;
-import org.junit.jupiter.api.Test;
+import java.util.stream.Stream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
public class AtbashTest {
- @Test
- public void atbashEncrypt() {
- AtbashCipher normalToEncrypt = new AtbashCipher("Hello World! 123, @cipher abcDEF ZYX 987 madam zzZ Palindrome!");
- String expectedText = "Svool Dliow! 123, @xrksvi zyxWVU ABC 987 nzwzn aaA Kzormwilnv!";
-
- normalToEncrypt.setString(normalToEncrypt.convert());
-
- assertEquals(expectedText, normalToEncrypt.getString());
+ @ParameterizedTest
+ @MethodSource("cipherTestProvider")
+ public void testAtbashCipher(String input, String expected) {
+ AtbashCipher cipher = new AtbashCipher(input);
+ assertEquals(expected, cipher.convert());
}
- @Test
- public void atbashDecrypt() {
- AtbashCipher encryptToNormal = new AtbashCipher("Svool Dliow! 123, @xrksvi zyxWVU ABC 987 nzwzn aaA Kzormwilnv!");
- String expectedText = "Hello World! 123, @cipher abcDEF ZYX 987 madam zzZ Palindrome!";
+ private static Stream