Package org.refcodes.codec

Interface BaseBuilder

All Superinterfaces:

BaseMetricsAccessor, BaseMetricsAccessor.BaseCodecMetricsProperty, BaseMetricsAccessor.BaseMetricsBuilder<BaseBuilder>, BaseMetricsAccessor.BaseMetricsMutator

All Known Implementing Classes:

BaseBuilderImpl

public interface BaseBuilder
extends BaseMetricsAccessor.BaseCodecMetricsProperty, BaseMetricsAccessor.BaseMetricsBuilder<BaseBuilder>

The BaseBuilder provides the functionality to do base encoding and decoding such as done by the Base64 encoding and decoding functionality (see "https://en.wikipedia.org/wiki/Base64"). The BaseBuilder makes use of the utility-Builder-Pattern and is designed to support codes starting with Base2 till Base64 and further up.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.codec.BaseMetricsAccessor

BaseMetricsAccessor.BaseCodecMetricsProperty, BaseMetricsAccessor.BaseMetricsBuilder<B extends BaseMetricsAccessor.BaseMetricsBuilder<B>>, BaseMetricsAccessor.BaseMetricsMutator

Method Summary

Modifier and Type	Method	Description
static BaseBuilder	build()	This is a convenience method for easily instantiating the according builder.
byte[]	getDecodedData()	Retrieves the decoded data from the decoded data property.
String	getEncodedText()	Retrieves the encoded text from the encoded text property.
default void	setBaseMetrics(int aNumberBase)	Sets the number base for the number base property.
void	setDecodedData(byte[] aDecodedData)	Sets the decoded data for the decoded data property.
void	setDecodedData(long aDecodedData)	Sets the decoded data for the decoded data property.
default void	setDecodedData(String aDecodedData)	Sets the decoded data for the decoded data property.
default void	setDecodedData(String aDecodedData, String aCharset)	Sets the decoded data for the decoded data property.
default void	setDecodedData(String aDecodedData, Charset aCharset)	Sets the decoded data for the decoded data property.
void	setEncodedText(String aEncodedText)	Sets the encoded text for the encoded text property.
byte[]	toDecodedData(String aEncodedText)	Retrieves the decoded data calculated from the provided encoded text.
String	toEncodedText(byte[] aDecodedData)	Retrieves the encoded text calculated from the decoded data.
String	toEncodedText(long aDecodedData)	Retrieves the encoded text calculated from the decoded data.
default String	toEncodedText(String aDecodedData)	Retrieves the encoded text calculated from the decoded data.
default String	toEncodedText(String aDecodedData, String aCharset)	Retrieves the encoded text calculated from the decoded data.
default String	toEncodedText(String aDecodedData, Charset aCharset)	Retrieves the encoded text calculated from the decoded data.
default BaseBuilder	withBaseMetrics(int aNumberBase)	Sets the number base for the number base property.
default BaseBuilder	withBaseMetrics(BaseMetrics aBaseMetricsCodec)	Sets the base codec metrics for the base codec metrics property.
default BaseBuilder	withDecodedData(byte[] aDecodedData)	Sets the decoded data for the decoded data property.
default BaseBuilder	withDecodedData(long aDecodedData)	Sets the decoded data for the decoded data property.
default BaseBuilder	withDecodedData(String aDecodedData)	Sets the decoded data for the decoded data property.
default BaseBuilder	withDecodedData(String aDecodedData, String aCharset)	Sets the decoded data for the decoded data property.
default BaseBuilder	withDecodedData(String aDecodedData, Charset aCharset)	Sets the decoded data for the decoded data property.
default BaseBuilder	withEncodedText(String aEncodedText)	Sets the encoded text for the encoded text property.

Methods inherited from interface org.refcodes.codec.BaseMetricsAccessor

getBaseMetrics

Methods inherited from interface org.refcodes.codec.BaseMetricsAccessor.BaseMetricsMutator

setBaseMetrics

Method Detail

withBaseMetrics

default BaseBuilder withBaseMetrics(BaseMetrics aBaseMetricsCodec)

Sets the base codec metrics for the base codec metrics property.

Specified by:

withBaseMetrics in interface BaseMetricsAccessor.BaseMetricsBuilder<BaseBuilder>

Parameters:

aBaseMetricsCodec - The base codec metrics to be stored by the font style property.

Returns:

The builder for applying multiple build operations.

setBaseMetrics

default void setBaseMetrics(int aNumberBase)

Sets the number base for the number base property.

Parameters:

aNumberBase - The number base to be stored by the base codec metrics property.

withBaseMetrics

default BaseBuilder withBaseMetrics(int aNumberBase)

Sets the number base for the number base property.

Parameters:

aNumberBase - The number base to be stored by the base codec metrics property.

Returns:

The builder for applying multiple build operations.

getEncodedText

String getEncodedText()

Retrieves the encoded text from the encoded text property.

Returns:

The encoded text stored by the encoded text property.

toEncodedText

String toEncodedText(byte[] aDecodedData)

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data (and the encoded result) is not part of the state for this instance (from the point of view of this method). Still changing for example the BaseMetrics via withBaseMetrics(BaseMetrics) can cause side effects! For avoiding thread race conditions / side effects regarding the decoded data (and the encoded result), use this method instead of the combination of withDecodedData(byte[]) with getEncodedText()

Parameters:

aDecodedData - The decoded data to be encoded.

Returns:

The encoded text calculated from the decoded data.

toEncodedText

default String toEncodedText(String aDecodedData)

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data (and the encoded result) is not part of the state for this instance (from the point of view of this method). Still changing for example the BaseMetrics via withBaseMetrics(BaseMetrics) can cause side effects! For avoiding thread race conditions / side effects regarding the decoded data (and the encoded result), use this method instead of the combination of withDecodedData(byte[]) with getEncodedText()

Parameters:

aDecodedData - The decoded data to be encoded.

Returns:

The encoded text calculated from the decoded data.

toEncodedText

default String toEncodedText(String aDecodedData,
                             Charset aCharset)

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data (and the encoded result) is not part of the state for this instance (from the point of view of this method). Still changing for example the BaseMetrics via withBaseMetrics(BaseMetrics) can cause side effects! For avoiding thread race conditions / side effects regarding the decoded data (and the encoded result), use this method instead of the combination of withDecodedData(byte[]) with getEncodedText()

Parameters:

aDecodedData - The decoded data to be encoded.

aCharset - The charset to use when interpreting the decoded data string.

Returns:

The encoded text calculated from the decoded data.

toEncodedText

default String toEncodedText(String aDecodedData,
                             String aCharset)
                      throws UnsupportedEncodingException

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data (and the encoded result) is not part of the state for this instance (from the point of view of this method). Still changing for example the BaseMetrics via withBaseMetrics(BaseMetrics) can cause side effects! For avoiding thread race conditions / side effects regarding the decoded data (and the encoded result), use this method instead of the combination of withDecodedData(byte[]) with getEncodedText()

Parameters:

aDecodedData - The decoded data to be encoded.

aCharset - The charset to use when interpreting the decoded data string.

Returns:

The encoded text calculated from the decoded data.

Throws:

UnsupportedEncodingException - thrown in case the provided charset name is not supported.

toEncodedText

String toEncodedText(long aDecodedData)

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data (and the encoded result) is not part of the state for this instance (from the point of view of this method). Still changing for example the BaseMetrics via withBaseMetrics(BaseMetrics) can cause side effects! For avoiding thread race conditions / side effects regarding the decoded data (and the encoded result), use this method instead of the combination of withDecodedData(byte[]) with getEncodedText()

Parameters:

aDecodedData - The decoded data to be encoded.

Returns:

The encoded text calculated from the decoded data.

setEncodedText

void setEncodedText(String aEncodedText)

Sets the encoded text for the encoded text property.

Parameters:

aEncodedText - The encoded text to be stored by the encoded text property.

withEncodedText

default BaseBuilder withEncodedText(String aEncodedText)

Sets the encoded text for the encoded text property.

Parameters:

aEncodedText - The encoded text to be stored by the encoded text property.

Returns:

The builder for applying multiple build operations.

getDecodedData

byte[] getDecodedData()

Retrieves the decoded data from the decoded data property.

Returns:

The decoded data stored by the decoded data property.

toDecodedData

byte[] toDecodedData(String aEncodedText)

Retrieves the decoded data calculated from the provided encoded text. This method is to be side effect free in terms of the encoded text (and the decoded result) is not part of the state for this instance (from the point of view of this method). Still changing for example the BaseMetrics via withBaseMetrics(BaseMetrics) can cause side effects! For avoiding thread race conditions / side effects regarding the encoded text (and the decoded result), use this method instead of the combination of withEncodedText(String) with getDecodedData().

Parameters:

aEncodedText - The encoded text to be decoded.

Returns:

The decoded data decoded from the encoded text.

setDecodedData

void setDecodedData(byte[] aDecodedData)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

setDecodedData

default void setDecodedData(String aDecodedData)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

setDecodedData

default void setDecodedData(String aDecodedData,
                            Charset aCharset)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

aCharset - The charset to use when interpreting the decoded data string.

setDecodedData

default void setDecodedData(String aDecodedData,
                            String aCharset)
                     throws UnsupportedEncodingException

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

aCharset - The charset to use when interpreting the decoded data string.

Throws:

UnsupportedEncodingException - thrown in case the provided charset name is not supported.

setDecodedData

void setDecodedData(long aDecodedData)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

withDecodedData

default BaseBuilder withDecodedData(byte[] aDecodedData)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

Returns:

The builder for applying multiple build operations.

withDecodedData

default BaseBuilder withDecodedData(String aDecodedData)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

Returns:

The builder for applying multiple build operations.

withDecodedData

default BaseBuilder withDecodedData(String aDecodedData,
                                    Charset aCharset)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

aCharset - The charset to use when interpreting the decoded data string.

Returns:

The builder for applying multiple build operations.

withDecodedData

default BaseBuilder withDecodedData(String aDecodedData,
                                    String aCharset)
                             throws UnsupportedEncodingException

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

aCharset - The charset to use when interpreting the decoded data string.

Returns:

The builder for applying multiple build operations.

Throws:

UnsupportedEncodingException - thrown in case the provided charset name is not supported.

withDecodedData

default BaseBuilder withDecodedData(long aDecodedData)

Sets the decoded data for the decoded data property.

Parameters:

aDecodedData - The decoded data to be stored by the decoded data property.

Returns:

The builder for applying multiple build operations.

build

static BaseBuilder build()

This is a convenience method for easily instantiating the according builder.

Returns:

an instance (using a default implementation) of this builder