Base58OutputStream (Apache Commons Codec 1.22.1 API)
Description: declaration: package: org.apache.commons.codec.binary, class: Base58OutputStream

Package org.apache.commons.codec.binary

# Class Base58OutputStream

java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
org.apache.commons.codec.binary.BaseNCodecOutputStream<Base58,Base58OutputStream,Base58OutputStream.Builder>
org.apache.commons.codec.binary.Base58OutputStream

All Implemented Interfaces:
  `Closeable`, `Flushable`, `AutoCloseable`

public class Base58OutputStream extends BaseNCodecOutputStream<Base58,Base58OutputStream,Base58OutputStream.Builder>
Provides Base58 encoding in a streaming fashion (unlimited size). When encoding the default lineLength is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate constructor.

The default behavior of the Base58OutputStream is to ENCODE, whereas the default behavior of the Base58InputStream is to DECODE. But this behavior can be overridden by using a different constructor.

Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).

Note: It is mandatory to close the stream after the last byte has been written to it, otherwise the final padding will be omitted and the resulting data will be incomplete/inconsistent.

You can set the decoding behavior when the input bytes contain leftover trailing bits that cannot be created by a valid encoding. These can be bits that are unused from the final character or entire characters. The default mode is lenient decoding.

- Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
- Strict: The decoding will throw an `IllegalArgumentException` if trailing bits are not part of a valid encoding. Any unused bits from the final character must be zero. Impossible counts of entire final characters are not allowed.

When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on the final character. This requires that the input bytes use the same padding and alphabet as the encoder.

Since:
  1.22.0
See Also:
  - `Base58`
  - The Base58 Encoding Scheme draft-msporny-base58-03

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static class`
  `Base58OutputStream.Builder`
  Builds instances of Base58OutputStream.

  ## Nested classes/interfaces inherited from class org.apache.commons.codec.binary.BaseNCodecOutputStream

  `BaseNCodecOutputStream.AbstractBuilder<T,C extends BaseNCodec,B extends BaseNCodecOutputStream.AbstractBuilder<T,C,B>>`

- ## Field Summary

  ### Fields inherited from class java.io.FilterOutputStream

  `out`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Base58OutputStream(OutputStream outputStream)`
  Constructs a Base58OutputStream such that all data written is Base58-encoded to the original provided OutputStream.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static Base58OutputStream.Builder`
  `builder()`
  Constructs a new Builder.

  ### Methods inherited from class org.apache.commons.codec.binary.BaseNCodecOutputStream

  `close, eof, flush, isStrictDecoding, write, write`

  ### Methods inherited from class java.io.FilterOutputStream

  `write`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### Base58OutputStream

    public Base58OutputStream(OutputStream outputStream)
    Constructs a Base58OutputStream such that all data written is Base58-encoded to the original provided OutputStream.
    Parameters:
      `outputStream` - OutputStream to wrap.

- ## Method Details

  - ### builder

    public static Base58OutputStream.Builder builder()
    Constructs a new Builder.
    Returns:
      A new Builder.