org.refcodes.codec.impls

Class BaseCodecBuilderImpl

java.lang.Object

org.refcodes.codec.impls.BaseCodecBuilderImpl

All Implemented Interfaces:

BaseCodecBuilder, BaseCodecMetricsAccessor, BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<BaseCodecBuilder>, BaseCodecMetricsAccessor.BaseCodecMetricsMutator, BaseCodecMetricsAccessor.BaseCodecMetricsProperty

public class BaseCodecBuilderImpl
extends Object
implements BaseCodecBuilder

Author:

steiner

Nested Class Summary

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

BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<B extends BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<B>>, BaseCodecMetricsAccessor.BaseCodecMetricsMutator, BaseCodecMetricsAccessor.BaseCodecMetricsProperty

Constructor Summary

Constructors

Constructor and Description
BaseCodecBuilderImpl()

Method Summary

Modifier and Type	Method and Description
BaseCodecMetrics	getBaseCodecMetrics() Retrieves the base codec metrics from the base codec metrics property.
byte[]	getDecodedData() Retrieves the decoded data from the decoded data property.
String	getEncodedText() Retrieves the encoded text from the encoded text property.
void	setBaseCodecMetrics(BaseCodecMetrics aBaseCodecMetrics) Sets the base codec metrics for the base codec metrics 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.
void	setEncodedText(String aEncodedText) Sets the encoded text for the encoded text property.
protected static int	toBytes(byte[] aDecodedBytes, int aOffset, int aWord, int aTrailingBytes, BaseCodecMetrics aBaseCodecMetrics)
byte[]	toDecodedData(String aEncodedText) Retrieves the decoded data calculated from the provided encoded text.
protected static int	toDecodedSize(String aEncodedText, BaseCodecMetrics aBaseCodecMetrics)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.codec.BaseCodecBuilder

setBaseCodecMetrics, withBaseCodecMetrics, withBaseCodecMetrics, withDecodedData, withDecodedData, withEncodedText

Constructor Detail

BaseCodecBuilderImpl

public BaseCodecBuilderImpl()

Method Detail

getBaseCodecMetrics

public BaseCodecMetrics getBaseCodecMetrics()

Description copied from interface: BaseCodecMetricsAccessor

Retrieves the base codec metrics from the base codec metrics property.

Specified by:

getBaseCodecMetrics in interface BaseCodecMetricsAccessor

Returns:

The base codec metrics stored by the base codec metrics property.

setBaseCodecMetrics

public void setBaseCodecMetrics(BaseCodecMetrics aBaseCodecMetrics)

Description copied from interface: BaseCodecMetricsAccessor.BaseCodecMetricsMutator

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

Specified by:

setBaseCodecMetrics in interface BaseCodecMetricsAccessor.BaseCodecMetricsMutator

Parameters:

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

getEncodedText

public String getEncodedText()

Description copied from interface: BaseCodecBuilder

Retrieves the encoded text from the encoded text property.

Specified by:

getEncodedText in interface BaseCodecBuilder

Returns:

The encoded text stored by the encoded text property.

setEncodedText

public void setEncodedText(String aEncodedText)

Description copied from interface: BaseCodecBuilder

Sets the encoded text for the encoded text property.

Specified by:

setEncodedText in interface BaseCodecBuilder

Parameters:

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

getDecodedData

public byte[] getDecodedData()

Description copied from interface: BaseCodecBuilder

Retrieves the decoded data from the decoded data property.

Specified by:

getDecodedData in interface BaseCodecBuilder

Returns:

The decoded data stored by the decoded data property.

setDecodedData

public void setDecodedData(byte[] aDecodedData)

Description copied from interface: BaseCodecBuilder

Sets the decoded data for the decoded data property.

Specified by:

setDecodedData in interface BaseCodecBuilder

Parameters:

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

setDecodedData

public void setDecodedData(long aDecodedData)

Description copied from interface: BaseCodecBuilder

Sets the decoded data for the decoded data property.

Specified by:

setDecodedData in interface BaseCodecBuilder

Parameters:

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

toEncodedText

public String toEncodedText(byte[] aDecodedData)

Description copied from interface: BaseCodecBuilder

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data as 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 BaseCodecMetrics via BaseCodecBuilder.withBaseCodecMetrics(BaseCodecMetrics) 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 BaseCodecBuilder.withDecodedData(byte[]) with BaseCodecBuilder.getEncodedText()

Specified by:

toEncodedText in interface BaseCodecBuilder

Parameters:

aDecodedData - The decoded data to be encoded.

Returns:

The encoded text calculated from the decoded data.

toDecodedData

public byte[] toDecodedData(String aEncodedText)

Description copied from interface: BaseCodecBuilder

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 BaseCodecMetrics via BaseCodecBuilder.withBaseCodecMetrics(BaseCodecMetrics) 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 BaseCodecBuilder.withEncodedText(String) with BaseCodecBuilder.getDecodedData().

Specified by:

toDecodedData in interface BaseCodecBuilder

Parameters:

aEncodedText - The encoded text to be decoded.

Returns:

The decoded data decoded from the encoded text.

toEncodedText

public String toEncodedText(long aDecodedData)

Description copied from interface: BaseCodecBuilder

Retrieves the encoded text calculated from the decoded data. This method is to be side effect free in terms of the decoded data as 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 BaseCodecMetrics via BaseCodecBuilder.withBaseCodecMetrics(BaseCodecMetrics) 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 BaseCodecBuilder.withDecodedData(byte[]) with BaseCodecBuilder.getEncodedText()

Specified by:

toEncodedText in interface BaseCodecBuilder

Parameters:

aDecodedData - The decoded data to be encoded.

Returns:

The encoded text calculated from the decoded data.

toDecodedSize

protected static int toDecodedSize(String aEncodedText,
                                   BaseCodecMetrics aBaseCodecMetrics)

toBytes

protected static int toBytes(byte[] aDecodedBytes,
                             int aOffset,
                             int aWord,
                             int aTrailingBytes,
                             BaseCodecMetrics aBaseCodecMetrics)