Tweaks.

Author: Dannemann

src/test/java/com/stringcompressor/FiveBitAsciiCompressorTest.java

@@ -17,6 +17,29 @@
  */
 public class FiveBitAsciiCompressorTest extends BaseTest {
 
+	@Test
+	public void usageExample() {
+		// A string to be compressed. Whenever possible, prefer working directly with byte[] to avoid creating String objects.
+		byte[] inputStr = "HELLO-COMPRESSOR".getBytes(US_ASCII);
+
+		// Creates a compressor with the default supported character set.
+		AsciiCompressor compressor = new FiveBitAsciiCompressor();
+		// Creates a compressor with a custom charset (see FiveBitAsciiCompressor.DEFAULT_5BIT_CHARSET)
+//		AsciiCompressor customCharsetCompressor = new FiveBitAsciiCompressor(new byte[]{/* custom charset */});
+
+		// Throws an exception when invalid characters are present; useful for debugging purposes.
+		// Invalid characters should be silently ignored in production. Default is false.
+		compressor.throwException = true;
+		// Compressor overwrites the original string ("inputStr") to reduce memory usage.
+		// Set to true to prevent this. Default is false.
+		compressor.preserveOriginal = false;
+
+		byte[] compressed = compressor.compress(inputStr);
+		byte[] decompressed = compressor.decompress(compressed);
+
+		assertEquals("HELLO-COMPRESSOR", new String(decompressed, US_ASCII));
+	}
+
 	@Test
 	public void validCustomCharsetTest() {
 		byte[] customCharset = new byte[]{

src/test/java/com/stringcompressor/FourBitAsciiCompressorTest.java

@@ -17,6 +17,29 @@
  */
 public class FourBitAsciiCompressorTest extends BaseTest {
 
+	@Test
+	public void usageExample() {
+		// A string to be compressed. Whenever possible, prefer working directly with byte[] to avoid creating String objects.
+		byte[] inputStr = "0123456789".getBytes(US_ASCII);
+
+		// Creates a compressor with the default supported character set.
+		AsciiCompressor compressor = new FourBitAsciiCompressor();
+		// Creates a compressor with a custom charset (see FourBitAsciiCompressor.DEFAULT_4BIT_CHARSET).
+//		AsciiCompressor customCharsetCompressor = new FourBitAsciiCompressor(new byte[]{/* custom charset */});
+
+		// Throws an exception when invalid characters are present; useful for debugging purposes.
+		// Invalid characters should be silently ignored in production. Default is false.
+		compressor.throwException = true;
+		// Compressor overwrites the original string ("inputStr") to reduce memory usage.
+		// Set to true to prevent this. Default is false.
+		compressor.preserveOriginal = false;
+
+		byte[] compressed = compressor.compress(inputStr);
+		byte[] decompressed = compressor.decompress(compressed);
+
+		assertEquals("0123456789", new String(decompressed, US_ASCII));
+	}
+
 	@Test
 	public void validCustomCharsetTest() {
 		byte[] customCharset = new byte[]{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15};

src/test/java/com/stringcompressor/SixBitAsciiCompressorTest.java

@@ -17,6 +17,29 @@
  */
 public class SixBitAsciiCompressorTest extends BaseTest {
 
+	@Test
+	public void usageExample() {
+		// A string to be compressed. Whenever possible, prefer working directly with byte[] to avoid creating String objects.
+		byte[] inputStr = "HELLO, COMPRESSOR".getBytes(US_ASCII);
+
+		// Creates a compressor with the default supported character set.
+		AsciiCompressor compressor = new SixBitAsciiCompressor();
+		// Creates a compressor with a custom charset (see SixBitAsciiCompressor.DEFAULT_6BIT_CHARSET).
+//		AsciiCompressor customCharsetCompressor = new SixBitAsciiCompressor(new byte[]{/* custom charset */});
+
+		// Throws an exception when invalid characters are present; useful for debugging purposes.
+		// Invalid characters should be silently ignored in production. Default is false.
+		compressor.throwException = true;
+		// Compressor overwrites the original string ("inputStr") to reduce memory usage.
+		// Set to true to prevent this. Default is false.
+		compressor.preserveOriginal = false;
+
+		byte[] compressed = compressor.compress(inputStr);
+		byte[] decompressed = compressor.decompress(compressed);
+
+		assertEquals("HELLO, COMPRESSOR", new String(decompressed, US_ASCII));
+	}
+
 	@Test
 	public void validCustomCharsetTest() {
 		byte[] customCharset = new byte[]{