Package org.refcodes.codec

Interface BaseBuilder

    • Method Detail

      • 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

        java.lang.String getEncodedText​()
        Retrieves the encoded text from the encoded text property.
        Returns:
        The encoded text stored by the encoded text property.

      • toEncodedText

        java.lang.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

        java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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

        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​(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.