Added logging

src/main/java/com/mattrixwv/cipherstream/monosubstitution/Vigenere.java

@@ -1,18 +1,24 @@
 //CipherStreamJava/src/main/java/com/mattrixwv/CipherStreamJava/monoSubstitution/Vigenere.java
 //Matthew Ellison
 // Created: 07-25-21
-//Modified: 02-22-22
+//Modified: 07-09-22
 package com.mattrixwv.cipherstream.monosubstitution;
 
 
 import java.util.ArrayList;
 import java.util.List;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import com.mattrixwv.cipherstream.exceptions.InvalidInputException;
 import com.mattrixwv.cipherstream.exceptions.InvalidKeywordException;
 
 
 public class Vigenere{
+	private static final Logger logger = LoggerFactory.getLogger(Vigenere.class);
+
+	//Fields
 	protected String inputString;	//This is the string that needs encoded/decoded
 	protected String outputString;	//This is the string that is output after encoding/decoding
 	protected String keyword;		//This is the keyword that is resposible for determining the offsets that you change each character by
@@ -23,6 +29,8 @@ public class Vigenere{
 
 	//Uses keyword to calculate the offset for the Caesar cipher for each character
 	protected void setOffset(){
+		logger.debug("Setting offset array from keyword");
+
 		//Reserve the correct size to increase speed later
 		offset.ensureCapacity(keyword.length());
 
@@ -31,6 +39,8 @@ public class Vigenere{
 			char letter = keyword.charAt(cnt);
 			offset.add((letter - 'A') % 26);
 		}
+
+		logger.debug("Offset {}", offset);
 	}
 	//Sets inputString
 	protected void setInputString(String inputString) throws InvalidInputException{
@@ -38,16 +48,25 @@ public class Vigenere{
 			throw new NullPointerException("Input cannot be null");
 		}
 
+		logger.debug("Original input string '{}'", inputString);
+
 		if(!preserveCapitals){
+			logger.debug("Removing case");
+
 			inputString = inputString.toUpperCase();
 		}
 		if(!preserveWhitespace){
+			logger.debug("Removing whitespace");
+
 			inputString = inputString.replaceAll("\\s", "");
 		}
 		if(!preserveSymbols){
+			logger.debug("Removing symbols");
+
 			inputString = inputString.replaceAll("[^a-zA-Z\\s]", "");
 		}
 
+		logger.debug("Cleaned input string '{}'", inputString);
 		this.inputString = inputString;
 
 		if(this.inputString.isBlank()){
@@ -60,11 +79,17 @@ public class Vigenere{
 			throw new NullPointerException("Keyword cannot be null");
 		}
 
+		logger.debug("Original keyword '{}'", keyword);
+
 		//Convert all letters to uppercase
+		logger.debug("Removing case");
 		keyword = keyword.toUpperCase();
 		//Remove all characters except capital letters
+		logger.debug("Removing all non-letter characters");
 		keyword = keyword.replaceAll("[^A-Z]", "");
+
 		//Save the string
+		logger.debug("Clean keyword '{}'", keyword);
 		this.keyword = keyword;
 
 		//Make sure offset is empty before adding to it
@@ -78,67 +103,113 @@ public class Vigenere{
 	}
 	//Encodes inputString and stores the result in outputString
 	protected String encode(){
+		logger.debug("Encoding");
+
 		StringBuilder output = new StringBuilder();
 
 		//Step through every character in the inputString and advance it the correct amount, according to offset
 		int offsetCnt = 0;
 		for(int inputCnt = 0;inputCnt < inputString.length();++inputCnt){
 			char letter = inputString.charAt(inputCnt);
+			logger.debug("Working character {}", letter);
+
 			if(Character.isUpperCase(letter)){
+				logger.debug("Encoding uppercase");
+
 				letter += offset.get((offsetCnt++) % offset.size());
+
 				//Make sure the character is still a letter, if not, wrap around
 				if(letter < 'A'){
+					logger.debug("Wrapping around to Z");
+
 					letter += 26;
 				}
 				else if(letter > 'Z'){
+					logger.debug("Wrapping around to A");
+
 					letter -= 26;
 				}
 			}
 			else if(Character.isLowerCase(letter)){
+				logger.debug("Encoding lowercase");
+
 				letter += offset.get((offsetCnt++) % offset.size());
+
 				//Make sure the character is still a letter, if not, wrap around
 				if(letter < 'a'){
+					logger.debug("Wrapping around to z");
+
 					letter += 26;
 				}
 				else if(letter > 'z'){
+					logger.debug("Wrapping around to a");
+
 					letter -= 26;
 				}
 			}
+
+			logger.debug("Encoded character {}", letter);
 			output.append(letter);
 		}
 
+		//Save output
+		logger.debug("Encoded message '{}'", output);
 		outputString = output.toString();
 		return outputString;
 	}
 	//Decodes inputString and stores the result in outputString
 	protected String decode(){
+		logger.debug("Decoding");
+
 		StringBuilder output = new StringBuilder();
 
 		//Step through every character in the inputString and advance it the correct amount, according to offset
 		int offsetCnt = 0;
 		for(int letterCnt = 0;letterCnt < inputString.length();++letterCnt){
 			char letter = inputString.charAt(letterCnt);
+
+			logger.debug("Working character {}", letter);
+
 			if(Character.isUpperCase(letter)){
+				logger.debug("Decoding uppercase");
+
 				letter -= offset.get((offsetCnt++) % offset.size());
+
 				if(letter < 'A'){
+					logger.debug("Wrapping around to Z");
+
 					letter += 26;
 				}
 				else if(letter > 'Z'){
+					logger.debug("Wrapping around to A");
+
 					letter -= 26;
 				}
 			}
 			else if(Character.isLowerCase(letter)){
+				logger.debug("Decoding lowercase");
+
 				letter -= offset.get((offsetCnt++) % offset.size());
+
 				if(letter < 'a'){
+					logger.debug("Wrapping around to z");
+
 					letter += 26;
 				}
 				else if(letter > 'z'){
+					logger.debug("Wrapping around to a");
+
 					letter -= 26;
 				}
 			}
+
+			//Add letter to output
+			logger.debug("Encoded letter {}", letter);
 			output.append(letter);
 		}
 
+		//Save output
+		logger.debug("Encoded message '{}'", output);
 		outputString = output.toString();
 		return outputString;
 	}
@@ -191,6 +262,8 @@ public class Vigenere{
 	}
 	//Makes sure all of the variables are empty
 	public void reset(){
+		logger.debug("Resetting fields");
+
 		inputString = "";
 		outputString = "";
 		keyword = "";