NoIssue: Better documentation

This commit is contained in:
Minimons
2025-12-03 10:37:58 +01:00
parent df259029bb
commit ca639ea6f6

View File

@@ -3,5 +3,12 @@ package com.r35157.libs.random;
import org.jetbrains.annotations.NotNull;
public interface RandomValueGeneratorString {
@NotNull String getSomeStringAlphaNumericOnly(int length);
/**
* Generate a random Alpha Numeric String of exactly the length given as the parameter.
*
* @param length Length of generated String - cannot be negative
* @return A non-null random String of the length given
* @throws IllegalArgumentException If length is negative
*/
@NotNull String getSomeStringAlphaNumericOnly(int length) throws IllegalArgumentException;
}