Package org.apache.commons.codec.binary

Class Base45.Builder

java.lang.Object

org.apache.commons.codec.binary.BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

org.apache.commons.codec.binary.Base45.Builder

All Implemented Interfaces:

java.util.function.Supplier<Base45>

Enclosing class:

Base45

public static class Base45.Builder
extends BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

Builds Base45 instances.

To configure a new instance, use a Base45.Builder. For example:

 Base45 base45 = Base45.builder().get();
 

Since:

1.23.0

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new instance using the Base45 alphabet as defined by RFC 9285.

Method Summary

Modifier and Type	Method	Description
Base45	get()
Base45.Builder	setDecodingPolicy(CodecPolicy decodingPolicy)	Sets the decoding policy.
Base45.Builder	setEncodeTable(byte... encodeTable)	Sets the encode table and derives the matching decode table, so the codec can always decode its own output.
Base45.Builder	setLineLength(int lineLength)	Always throws UnsupportedOperationException; unsupported by Base45 RFC 9285.
Base45.Builder	setLineSeparator(byte... lineSeparator)	Always throws UnsupportedOperationException; unsupported by Base45 RFC 9285.
Base45.Builder	setPadding(byte padding)	Always throws UnsupportedOperationException; unsupported by Base45 RFC 9285.

Methods inherited from class org.apache.commons.codec.binary.BaseNCodec.AbstractBuilder

setDecodeTable

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a new instance using the Base45 alphabet as defined by RFC 9285.

Method Detail

get

public Base45 get()

setDecodingPolicy

public Base45.Builder setDecodingPolicy(CodecPolicy decodingPolicy)

Sets the decoding policy. CodecPolicy.STRICT is the only supported policy.

Overrides:

setDecodingPolicy in class BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

Parameters:

decodingPolicy - The decoding policy; null resets to the default (CodecPolicy.STRICT).

Returns:

this instance.

Throws:

java.lang.IllegalArgumentException - Thrown if the given policy is CodecPolicy.LENIENT.

setEncodeTable

public Base45.Builder setEncodeTable(byte... encodeTable)

Sets the encode table and derives the matching decode table, so the codec can always decode its own output.

Overrides:

setEncodeTable in class BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

Parameters:

encodeTable - The encode table with exactly 45 unique entries, null resets to the default.

Returns:

this instance.

Throws:

java.lang.IllegalArgumentException - Thrown if the encode table does not contain exactly 45 unique entries.

setLineLength

public Base45.Builder setLineLength(int lineLength)

Always throws UnsupportedOperationException; unsupported by Base45 RFC 9285.

Overrides:

setLineLength in class BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

Parameters:

lineLength - The line length, less than 0 resets to the default.

Returns:

this instance.

Throws:

java.lang.UnsupportedOperationException - Thrown because Base45 RFC 9285 does not support this operation.

setLineSeparator

public Base45.Builder setLineSeparator(byte... lineSeparator)

Always throws UnsupportedOperationException; unsupported by Base45 RFC 9285.

Overrides:

setLineSeparator in class BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

Parameters:

lineSeparator - The line separator, null resets to the default.

Returns:

this instance.

Throws:

java.lang.UnsupportedOperationException - Thrown because Base45 RFC 9285 does not support this operation.

setPadding

public Base45.Builder setPadding(byte padding)

Always throws UnsupportedOperationException; unsupported by Base45 RFC 9285.

Overrides:

setPadding in class BaseNCodec.AbstractBuilder<Base45,Base45.Builder>

Parameters:

padding - The padding byte.

Returns:

this instance.

Throws:

java.lang.UnsupportedOperationException - Thrown because Base45 RFC 9285 does not support this operation.