Package org.apache.commons.codec.binary

Class BaseNCodec.AbstractBuilder<T,B extends BaseNCodec.AbstractBuilder<T,B>>

java.lang.Object

org.apache.commons.codec.binary.BaseNCodec.AbstractBuilder<T,B>

Type Parameters:

T - the codec type to build.

B - the codec builder subtype.

All Implemented Interfaces:

java.util.function.Supplier<T>

Direct Known Subclasses:

Base16.Builder, Base32.Builder, Base58.Builder, Base64.Builder

Enclosing class:

BaseNCodec

public abstract static class BaseNCodec.AbstractBuilder<T,B extends BaseNCodec.AbstractBuilder<T,B>>
extends java.lang.Object
implements java.util.function.Supplier<T>

Builds Base64 instances.

Since:

1.17.0

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	decodeTable
private CodecPolicy	decodingPolicy
private byte[]	defaultEncodeTable
private int	encodedBlockSize
private byte[]	encodeTable
private int	lineLength
private byte[]	lineSeparator
private byte	padding	Padding byte.
private int	unencodedBlockSize

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder(byte[] defaultEncodeTable)

Method Summary

Modifier and Type	Method	Description
(package private) B	asThis()	Returns this instance typed as the subclass type B.
(package private) byte[]	getDecodeTable()
(package private) CodecPolicy	getDecodingPolicy()
(package private) int	getEncodedBlockSize()
(package private) byte[]	getEncodeTable()
(package private) int	getLineLength()
(package private) byte[]	getLineSeparator()
(package private) byte	getPadding()
(package private) int	getUnencodedBlockSize()
B	setDecodeTable(byte[] decodeTable)	Sets the decode table.
(package private) B	setDecodeTableRaw(byte[] decodeTable)	Sets the decode table.
B	setDecodingPolicy(CodecPolicy decodingPolicy)	Sets the decoding policy.
(package private) B	setEncodedBlockSize(int encodedBlockSize)	Sets the encoded block size, subclasses normally set this on construction.
B	setEncodeTable(byte... encodeTable)	Sets the encode table.
(package private) B	setEncodeTableRaw(byte... encodeTable)	Sets the encode table.
B	setLineLength(int lineLength)	Sets the line length.
B	setLineSeparator(byte... lineSeparator)	Sets the line separator.
B	setPadding(byte padding)	Sets the padding byte.
(package private) B	setUnencodedBlockSize(int unencodedBlockSize)	Sets the unencoded block size, subclasses normally set this on construction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Supplier

get

Field Detail

unencodedBlockSize

private int unencodedBlockSize

encodedBlockSize

private int encodedBlockSize

decodingPolicy

private CodecPolicy decodingPolicy

lineLength

private int lineLength

lineSeparator

private byte[] lineSeparator

defaultEncodeTable

private final byte[] defaultEncodeTable

encodeTable

private byte[] encodeTable

decodeTable

private byte[] decodeTable

padding

private byte padding

Padding byte.

Constructor Detail

AbstractBuilder

AbstractBuilder(byte[] defaultEncodeTable)

Method Detail

asThis

B asThis()

Returns this instance typed as the subclass type B.

This is the same as the expression:

 (B) this
 

Returns:

this instance typed as the subclass type B.

getDecodeTable

byte[] getDecodeTable()

getDecodingPolicy

CodecPolicy getDecodingPolicy()

getEncodedBlockSize

int getEncodedBlockSize()

getEncodeTable

byte[] getEncodeTable()

getLineLength

int getLineLength()

getLineSeparator

byte[] getLineSeparator()

getPadding

byte getPadding()

getUnencodedBlockSize

int getUnencodedBlockSize()

setDecodeTable

public B setDecodeTable(byte[] decodeTable)

Sets the decode table.

Parameters:

decodeTable - the decode table.

Returns:

this instance.

Since:

1.20.0

setDecodeTableRaw

B setDecodeTableRaw(byte[] decodeTable)

Sets the decode table.

Parameters:

decodeTable - the decode table, null resets to the default.

Returns:

this instance.

setDecodingPolicy

public B setDecodingPolicy(CodecPolicy decodingPolicy)

Sets the decoding policy.

Parameters:

decodingPolicy - the decoding policy, null resets to the default.

Returns:

this instance.

setEncodedBlockSize

B setEncodedBlockSize(int encodedBlockSize)

Sets the encoded block size, subclasses normally set this on construction.

Parameters:

encodedBlockSize - the encoded block size, subclasses normally set this on construction.

Returns:

this instance.

setEncodeTable

public B setEncodeTable(byte... encodeTable)

Sets the encode table.

Parameters:

encodeTable - the encode table, null resets to the default.

Returns:

this instance.

setEncodeTableRaw

B setEncodeTableRaw(byte... encodeTable)

Sets the encode table.

Parameters:

encodeTable - the encode table, null resets to the default.

Returns:

this instance.

setLineLength

public B setLineLength(int lineLength)

Sets the line length.

Parameters:

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

Returns:

this instance.

setLineSeparator

public B setLineSeparator(byte... lineSeparator)

Sets the line separator.

Parameters:

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

Returns:

this instance.

setPadding

public B setPadding(byte padding)

Sets the padding byte.

Parameters:

padding - the padding byte.

Returns:

this instance.

setUnencodedBlockSize

B setUnencodedBlockSize(int unencodedBlockSize)

Sets the unencoded block size, subclasses normally set this on construction.

Parameters:

unencodedBlockSize - the unencoded block size, subclasses normally set this on construction.

Returns:

this instance.