Added Javadoc comments to the classes

This commit is contained in:
2024-08-11 23:48:02 -04:00
parent b16956b184
commit c10df8e5df
29 changed files with 3270 additions and 431 deletions

View File

@@ -1,20 +1,58 @@
//CipherStreamJava/src/main/java/com/mattrixwv/CipherStreamJava/Exceptions/InvalidKeywordException.java
//Mattrixwv
// Created: 01-09-22
//Modified: 01-09-22
//Modified: 08-11-24
/*
Copyright (C) 2024 Mattrixwv
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.mattrixwv.cipherstream.exceptions;
/**
* Thrown to indicate that a problem has occurred related to an invalid keyword.
*/
public class InvalidKeywordException extends RuntimeException{
/**
* Constructs a new {@code InvalidKeywordException} with {@code null} as its detail message.
*/
public InvalidKeywordException(){
super();
}
/**
* Constructs a new {@code InvalidKeywordException} with the specified detail message.
*
* @param message the detail message, which is saved for later retrieval by the {@link #getMessage()} method
*/
public InvalidKeywordException(String message){
super(message);
}
/**
* Constructs a new {@code InvalidKeywordException} with the specified cause.
*
* @param error the cause, which is saved for later retrieval by the {@link #getCause()} method
*/
public InvalidKeywordException(Throwable error){
super(error);
}
/**
* Constructs a new {@code InvalidKeywordException} with the specified detail message and cause.
*
* @param message the detail message, which is saved for later retrieval by the {@link #getMessage()} method
* @param error the cause, which is saved for later retrieval by the {@link #getCause()} method
*/
public InvalidKeywordException(String message, Throwable error){
super(message, error);
}