org.refcodes.codec

Class BaseBuilderImpl

java.lang.Object

org.refcodes.codec.BaseBuilderImpl

All Implemented Interfaces:

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

public class BaseBuilderImpl
extends Object
implements BaseBuilder

Vanilla plain implementation of the BaseBuilder interface.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
BaseBuilderImpl()

Method Summary

Modifier and Type	Method and Description
BaseMetrics	getBaseMetrics() 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	setBaseMetrics(BaseMetrics aBaseMetrics) 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, BaseMetrics aBaseMetrics) To bytes.
byte[]	toDecodedData(String aEncodedText) Retrieves the decoded data calculated from the provided encoded text.
protected static byte[]	toDecodedData(String aEncodedText, BaseMetrics aBaseMetrics) To decoded data.
protected static int	toDecodedSize(String aEncodedText, BaseMetrics aBaseMetrics) To decoded size.
String	toEncodedText(byte[] aDecodedData) Retrieves the encoded text calculated from the decoded data.
protected static String	toEncodedText(byte[] aDecodedData, BaseMetrics aBaseMetrics) To encoded text.
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.BaseBuilder

setBaseMetrics, withBaseMetrics, withBaseMetrics, withDecodedData, withDecodedData, withEncodedText

Constructor Detail

BaseBuilderImpl

public BaseBuilderImpl()

Method Detail

getBaseMetrics

public BaseMetrics getBaseMetrics()

Description copied from interface: BaseMetricsAccessor

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

Specified by:

getBaseMetrics in interface BaseMetricsAccessor

Returns:

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

setBaseMetrics

public void setBaseMetrics(BaseMetrics aBaseMetrics)

Description copied from interface: BaseMetricsAccessor.BaseMetricsMutator

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

Specified by:

setBaseMetrics in interface BaseMetricsAccessor.BaseMetricsMutator

Parameters:

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

getEncodedText

public String getEncodedText()

Description copied from interface: BaseBuilder

Retrieves the encoded text from the encoded text property.

Specified by:

getEncodedText in interface BaseBuilder

Returns:

The encoded text stored by the encoded text property.

setEncodedText

public void setEncodedText(String aEncodedText)

Description copied from interface: BaseBuilder

Sets the encoded text for the encoded text property.

Specified by:

setEncodedText in interface BaseBuilder

Parameters:

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

getDecodedData

public byte[] getDecodedData()

Description copied from interface: BaseBuilder

Retrieves the decoded data from the decoded data property.

Specified by:

getDecodedData in interface BaseBuilder

Returns:

The decoded data stored by the decoded data property.

setDecodedData

public void setDecodedData(byte[] aDecodedData)

Description copied from interface: BaseBuilder

Sets the decoded data for the decoded data property.

Specified by:

setDecodedData in interface BaseBuilder

Parameters:

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

setDecodedData

public void setDecodedData(long aDecodedData)

Description copied from interface: BaseBuilder

Sets the decoded data for the decoded data property.

Specified by:

setDecodedData in interface BaseBuilder

Parameters:

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

toEncodedText

public String toEncodedText(byte[] aDecodedData)

Description copied from interface: BaseBuilder

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 BaseBuilder.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 BaseBuilder.withDecodedData(byte[]) with BaseBuilder.getEncodedText()

Specified by:

toEncodedText in interface BaseBuilder

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: BaseBuilder

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 BaseBuilder.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 BaseBuilder.withEncodedText(String) with BaseBuilder.getDecodedData().

Specified by:

toDecodedData in interface BaseBuilder

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: BaseBuilder

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 BaseBuilder.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 BaseBuilder.withDecodedData(byte[]) with BaseBuilder.getEncodedText()

Specified by:

toEncodedText in interface BaseBuilder

Parameters:

aDecodedData - The decoded data to be encoded.

Returns:

The encoded text calculated from the decoded data.

toEncodedText

protected static String toEncodedText(byte[] aDecodedData,
                                      BaseMetrics aBaseMetrics)

To encoded text.

Parameters:

aDecodedData - the a decoded data

aBaseMetrics - the a base metrics

Returns:

the string

toDecodedData

protected static byte[] toDecodedData(String aEncodedText,
                                      BaseMetrics aBaseMetrics)

To decoded data.

Parameters:

aEncodedText - the a encoded text

aBaseMetrics - the a base metrics

Returns:

the byte[]

toDecodedSize

protected static int toDecodedSize(String aEncodedText,
                                   BaseMetrics aBaseMetrics)

To decoded size.

Parameters:

aEncodedText - the a encoded text

aBaseMetrics - the a base metrics

Returns:

the int

toBytes

protected static int toBytes(byte[] aDecodedBytes,
                             int aOffset,
                             int aWord,
                             int aTrailingBytes,
                             BaseMetrics aBaseMetrics)

To bytes.

Parameters:

aDecodedBytes - the a decoded bytes

aOffset - the a offset

aWord - the a word

aTrailingBytes - the a trailing bytes

aBaseMetrics - the a base metrics

Returns:

the int