Skip to content

Commit

Permalink
Add documentation to public constants
Browse files Browse the repository at this point in the history
  • Loading branch information
robhanlon22 committed Nov 28, 2023
1 parent a1fb929 commit 8cd595e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/main/java/org/sqids/Sqids.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,21 @@
* This implementation is immutable and thread-safe, no lock is necessary.
*/
public class Sqids {
/**
* The minimum allowable length of the alphabet used for encoding and
* decoding Sqids.
*/
public static final int MIN_ALPHABET_LENGTH = 3;

/**
* The maximum allowable minimum length of an encoded Sqid.
*/
public static final int MIN_LENGTH_LIMIT = 255;

/**
* The minimum length of blocked words in the block list. Any words shorter
* than the minimum are ignored.
*/
public static final int MIN_BLOCK_LIST_WORD_LENGTH = 3;

private final String alphabet;
Expand Down

0 comments on commit 8cd595e

Please sign in to comment.