# Deprecated API

## Contents

- Deprecated Classes
- Deprecated Fields
- Deprecated Methods
- Deprecated Constructors

- Deprecated Classes
  Class and Description
  org.apache.commons.codec.language.Caverphone 1.5 Replaced by `Caverphone2`, will be removed in 2.0.
  org.apache.commons.codec.digest.MurmurHash3.IncrementalHash32 Use IncrementalHash32x86. This corrects the processing of trailing bytes.

- Deprecated Fields
  Field and Description
  org.apache.commons.codec.net.URLCodec.charset TODO: This field will be changed to a private final Charset in 2.0. (CODEC-126)
  org.apache.commons.codec.Charsets.ISO_8859_1 Use `StandardCharsets.ISO_8859_1` instead.
  org.apache.commons.codec.digest.MurmurHash3.NULL_HASHCODE This is not used internally and will be removed in a future release.
  org.apache.commons.codec.binary.BaseNCodec.PAD Use `BaseNCodec.pad`. Will be removed in 2.0.
  org.apache.commons.codec.Charsets.US_ASCII Use `StandardCharsets.US_ASCII` instead.
  org.apache.commons.codec.Charsets.UTF_16 Use `StandardCharsets.UTF_16` instead.
  org.apache.commons.codec.Charsets.UTF_16BE Use `StandardCharsets.UTF_16BE` instead.
  org.apache.commons.codec.Charsets.UTF_16LE Use `StandardCharsets.UTF_16LE` instead.
  org.apache.commons.codec.Charsets.UTF_8 Use `StandardCharsets.UTF_8` instead.
  org.apache.commons.codec.net.URLCodec.WWW_FORM_URL 1.11 Will be removed in 2.0 (CODEC-230)

- Deprecated Methods
  Method and Description
  org.apache.commons.codec.net.URLCodec.getEncoding() Use `URLCodec.getDefaultCharset()`, will be removed in 2.0.
  org.apache.commons.codec.digest.HmacUtils.getHmacMd5(byte[]) (1.11) Use `getInitializedMac(HmacAlgorithms.HMAC_MD5, byte[])`
  org.apache.commons.codec.digest.HmacUtils.getHmacSha1(byte[]) (1.11) Use `getInitializedMac(HmacAlgorithms.HMAC_SHA_1, byte[])`
  org.apache.commons.codec.digest.HmacUtils.getHmacSha256(byte[]) (1.11) Use `getInitializedMac(HmacAlgorithms.HMAC_SHA_256, byte[])`
  org.apache.commons.codec.digest.HmacUtils.getHmacSha384(byte[]) (1.11) Use `getInitializedMac(HmacAlgorithms.HMAC_SHA_384, byte[])`
  org.apache.commons.codec.digest.HmacUtils.getHmacSha512(byte[]) (1.11) Use `getInitializedMac(HmacAlgorithms.HMAC_SHA_512, byte[])`
  org.apache.commons.codec.language.Soundex.getMaxLength() This feature is not needed since the encoding size must be constant. Will be removed in 2.0.
  org.apache.commons.codec.digest.DigestUtils.getShaDigest() (1.11) Use `DigestUtils.getSha1Digest()`
  org.apache.commons.codec.digest.MurmurHash3.hash128(byte[], int, int, int) Use `MurmurHash3.hash128x64(byte[], int, int, int)`. This corrects the seed initialization.
  org.apache.commons.codec.digest.MurmurHash3.hash128(String) Use `MurmurHash3.hash128x64(byte[])` using the bytes returned from `String.getBytes(java.nio.charset.Charset)`.
  org.apache.commons.codec.digest.MurmurHash3.hash32(byte[]) Use `MurmurHash3.hash32x86(byte[], int, int, int)`. This corrects the processing of trailing bytes.
  org.apache.commons.codec.digest.MurmurHash3.hash32(byte[], int) Use `MurmurHash3.hash32x86(byte[], int, int, int)`. This corrects the processing of trailing bytes.
  org.apache.commons.codec.digest.MurmurHash3.hash32(byte[], int, int) Use `MurmurHash3.hash32x86(byte[], int, int, int)`. This corrects the processing of trailing bytes.
  org.apache.commons.codec.digest.MurmurHash3.hash32(byte[], int, int, int) Use `MurmurHash3.hash32x86(byte[], int, int, int)`. This corrects the processing of trailing bytes.
  org.apache.commons.codec.digest.MurmurHash3.hash32(String) Use `MurmurHash3.hash32x86(byte[], int, int, int)` with the bytes returned from `String.getBytes(java.nio.charset.Charset)`. This corrects the processing of trailing bytes.
  org.apache.commons.codec.digest.MurmurHash3.hash64(byte[]) Not part of the MurmurHash3 implementation. Use half of the hash bytes from `MurmurHash3.hash128x64(byte[])`.
  org.apache.commons.codec.digest.MurmurHash3.hash64(byte[], int, int) Not part of the MurmurHash3 implementation. Use half of the hash bytes from `MurmurHash3.hash128x64(byte[], int, int, int)`.
  org.apache.commons.codec.digest.MurmurHash3.hash64(byte[], int, int, int) Not part of the MurmurHash3 implementation. Use half of the hash bytes from `MurmurHash3.hash128x64(byte[], int, int, int)`.
  org.apache.commons.codec.digest.MurmurHash3.hash64(int) Not part of the MurmurHash3 implementation. Use half of the hash bytes from `MurmurHash3.hash128x64(byte[])` with the bytes from the `int`.
  org.apache.commons.codec.digest.MurmurHash3.hash64(long) Not part of the MurmurHash3 implementation. Use half of the hash bytes from `MurmurHash3.hash128x64(byte[])` with the bytes from the `long`.
  org.apache.commons.codec.digest.MurmurHash3.hash64(short) Not part of the MurmurHash3 implementation. Use half of the hash bytes from `MurmurHash3.hash128x64(byte[])` with the bytes from the `short`.
  org.apache.commons.codec.digest.HmacUtils.hmacMd5(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmac(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacMd5(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmac(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacMd5(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_MD5, String).hmac(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacMd5Hex(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmacHex(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacMd5Hex(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmacHex(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacMd5Hex(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_MD5, String).hmacHex(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha1(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmac(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha1(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmac(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha1(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_1, String).hmac(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha1Hex(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmacHex(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha1Hex(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmacHex(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha1Hex(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_1, String).hmacHex(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha256(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmac(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha256(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmac(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha256(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_256, String).hmac(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha256Hex(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmacHex(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha256Hex(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmacHex(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha256Hex(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_256, String).hmacHex(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha384(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmac(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha384(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmac(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha384(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_384, String).hmac(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha384Hex(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmacHex(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha384Hex(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmacHex(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha384Hex(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_384, String).hmacHex(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha512(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmac(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha512(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmac(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha512(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_512, String).hmac(String)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha512Hex(byte[], byte[]) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmacHex(byte[])`
  org.apache.commons.codec.digest.HmacUtils.hmacSha512Hex(byte[], InputStream) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmacHex(InputStream)`
  org.apache.commons.codec.digest.HmacUtils.hmacSha512Hex(String, String) (1.11) Use `new HmacUtils(HmacAlgorithms.HMAC_SHA_512, String).hmacHex(String)`
  org.apache.commons.codec.binary.Base64.isArrayByteBase64(byte[]) 1.5 Use `Base64.isBase64(byte[])`, will be removed in 2.0.
  org.apache.commons.codec.binary.BaseNCodec.isWhiteSpace(byte) Use `Character.isWhitespace(int)`.
  org.apache.commons.codec.language.bm.Rule.Phoneme.join(Rule.Phoneme) since 1.9
  org.apache.commons.codec.language.Soundex.setMaxLength(int) This feature is not needed since the encoding size must be constant. Will be removed in 2.0.
  org.apache.commons.codec.digest.DigestUtils.sha(byte[]) (1.11) Use `DigestUtils.sha1(byte[])`
  org.apache.commons.codec.digest.DigestUtils.sha(InputStream) (1.11) Use `DigestUtils.sha1(InputStream)`
  org.apache.commons.codec.digest.DigestUtils.sha(String) (1.11) Use `DigestUtils.sha1(String)`
  org.apache.commons.codec.digest.DigestUtils.shaHex(byte[]) (1.11) Use `DigestUtils.sha1Hex(byte[])`
  org.apache.commons.codec.digest.DigestUtils.shaHex(InputStream) (1.11) Use `DigestUtils.sha1Hex(InputStream)`
  org.apache.commons.codec.digest.DigestUtils.shaHex(String) (1.11) Use `DigestUtils.sha1Hex(String)`

- Deprecated Constructors
  Constructor and Description
  org.apache.commons.codec.digest.DigestUtils() since 1.11; only useful to preserve binary compatibility
  org.apache.commons.codec.digest.HmacUtils() since 1.11; only useful to preserve binary compatibility
  org.apache.commons.codec.StringEncoderComparator() Creating an instance without a `StringEncoder` leads to a `NullPointerException`. Will be removed in 2.0.

Copyright © 2002–2023 The Apache Software Foundation. All rights reserved.