org.refcodes.codec.BaseMetrics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-codec Show documentation
Show all versions of refcodes-codec Show documentation
Artifact with encoding and decoding (not in terms of encryption/decryption)
implementations (codecs) such as BASE64 encoding / decoding.
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////
package org.refcodes.codec;
import org.refcodes.mixin.CharSetAccessor;
import org.refcodes.numerical.NumberBaseAccessor;
import org.refcodes.numerical.PaddingCharAccessor;
/**
* The {@link BaseMetrics} provide the metrics for a codec to be used by an
* implementation of the {@link BaseBuilder}, the {@link BaseDecoder}, the
* {@link BaseEncoder} or the like.
*
*/
public interface BaseMetrics extends CharSetAccessor, PaddingCharAccessor, NumberBaseAccessor {
/**
* {@inheritDoc}
*/
@Override
char[] getCharSet();
/**
* Number of bytes to exactly store a minimum number of digits.
*
* @return the bytes per int
*/
int getBytesPerInt();
/**
* Number of digits stored in an integer.
*
* @return the digits per int
*/
int getDigitsPerInt();
/**
* Number in bits for one digit.
*
* @return the bits per digit
*/
int getBitsPerDigit();
/**
* Number of digits required to represent a byte.
*
* @return the digits per byte
*/
int getDigitsPerByte();
/**
* The digit mask is the bit-field covering just the digit's bits (starting
* at bit 0). Those bits in the mask are set to one which are required to
* represent a digit.
*
* @return the digit mask
*/
int getDigitMask();
/**
* Retrieves the (decoded) value for the (encoded) character.
*
* @param aChar the char
* @return the int
*/
int toValue( char aChar );
/**
* Retrieves the (encoded) character for the (decoded) value.
*
* @param aValue the value
* @return the char
*/
char toChar( int aValue );
}