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:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class Base58OutputStream
extends BaseNCodecOutputStream<Base58,Base58OutputStream,Base58OutputStream.Builder>

Provides Base58 encoding through a stream interface.

The default behavior of Base58InputStream is to decode, and the default behavior of Base58OutputStream is to encode. The builder can select either behavior with setEncode(boolean).

Results are available only after EOF. Decoding accepts at most Base58.DEFAULT_MAX_DECODE_LENGTH encoded bytes by default and throws IOException when an input chunk would exceed the cumulative limit. To configure the limit, pass a codec built with Base58.Builder.setMaxDecodeLength(int) to the stream builder's setBaseNCodec(Base58) method.

Encoding accepts at most Base58.DEFAULT_MAX_ENCODE_LENGTH binary bytes by default and throws IOException when an input chunk would exceed that cumulative limit. Configure it with Base58.Builder.setMaxEncodeLength(int) on the codec passed to setBaseNCodec(Base58).

The complete input is retained until EOF. Memory usage is proportional to the accumulated input and conversion output. Configure both input limits appropriately for larger trusted values; encoded output can exceed the decode limit.

Close the output stream or call BaseNCodecOutputStream.eof() after the last write to complete conversion.

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(java.io.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.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

Base58OutputStream

public Base58OutputStream(java.io.OutputStream outputStream)

Constructs a Base58OutputStream such that all data written is Base58-encoded to the original provided OutputStream.

Parameters:

outputStream - OutputStream to wrap.

Method Detail

builder

public static Base58OutputStream.Builder builder()

Constructs a new Builder.

Returns:

A new Builder.