A B C D E F G H I M O Q R S T U W

A

append(char) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

append(char, char) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

append(String) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

append(String, String) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

appendAlternate(char) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

appendAlternate(String) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

appendPrimary(char) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

appendPrimary(String) - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

B

Base64 - Class in org.apache.commons.codec.binary

Provides Base64 encoding and decoding as defined by RFC 2045.

Base64() - Constructor for class org.apache.commons.codec.binary.Base64

BCodec - Class in org.apache.commons.codec.net

Identical to the Base64 encoding defined by RFC 1521 and allows a character set to be specified.

BCodec() - Constructor for class org.apache.commons.codec.net.BCodec

Default constructor.

BCodec(String) - Constructor for class org.apache.commons.codec.net.BCodec

Constructor which allows for the selection of a default charset

BinaryCodec - Class in org.apache.commons.codec.binary

Translates between byte arrays and strings of "0"s and "1"s.

BinaryCodec() - Constructor for class org.apache.commons.codec.binary.BinaryCodec

BinaryDecoder - Interface in org.apache.commons.codec

Defines common decoding methods for byte array decoders.

BinaryEncoder - Interface in org.apache.commons.codec

Defines common encoding methods for byte array encoders.

C

charAt(String, int) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Gets the character at index index if available, otherwise it returns Character.MIN_VALUE so that there is some sort of a default

charset - Variable in class org.apache.commons.codec.net.URLCodec

The default charset used for string decoding and encoding.

compare(Object, Object) - Method in class org.apache.commons.codec.StringEncoderComparator

Compares two strings based not on the strings themselves, but on an encoding of the two strings using the StringEncoder this Comparator was created with.

contains(String, int, int, String[]) - Static method in class org.apache.commons.codec.language.DoubleMetaphone

Determines whether value contains any of the criteria starting at index start and matching up to length length

D

decode(Object) - Method in class org.apache.commons.codec.binary.Base64

Decodes an Object using the base64 algorithm.

decode(byte[]) - Method in class org.apache.commons.codec.binary.Base64

Decodes a byte[] containing containing characters in the Base64 alphabet.

decode(Object) - Method in class org.apache.commons.codec.binary.BinaryCodec

Decodes a byte array where each byte represents an ascii '0' or '1'.

decode(byte[]) - Method in class org.apache.commons.codec.binary.BinaryCodec

Decodes a byte array where each byte represents an ascii '0' or '1'.

decode(byte[]) - Method in class org.apache.commons.codec.binary.Hex

Converts an array of character bytes representing hexidecimal values into an array of bytes of those same values.

decode(Object) - Method in class org.apache.commons.codec.binary.Hex

Converts a String or an array of character bytes representing hexidecimal values into an array of bytes of those same values.

decode(byte[]) - Method in interface org.apache.commons.codec.BinaryDecoder

Decodes a byte array and returns the results as a byte array.

decode(Object) - Method in interface org.apache.commons.codec.Decoder

Decodes an "encoded" Object and returns a "decoded" Object.

decode(String) - Method in class org.apache.commons.codec.net.BCodec

Decodes a Base64 string into its original form.

decode(Object) - Method in class org.apache.commons.codec.net.BCodec

Decodes a Base64 object into its original form.

decode(String) - Method in class org.apache.commons.codec.net.QCodec

Decodes a quoted-printable string into its original form.

decode(Object) - Method in class org.apache.commons.codec.net.QCodec

Decodes a quoted-printable object into its original form.

decode(byte[]) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Decodes an array of quoted-printable characters into an array of original bytes.

decode(String, String) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Decodes a quoted-printable string into its original form using the specified string charset.

decode(String) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Decodes a quoted-printable string into its original form using the default string charset.

decode(Object) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Decodes a quoted-printable object into its original form.

decode(byte[]) - Method in class org.apache.commons.codec.net.URLCodec

Decodes an array of URL safe 7-bit characters into an array of original bytes.

decode(String, String) - Method in class org.apache.commons.codec.net.URLCodec

Decodes a URL safe string into its original form using the specified encoding.

decode(String) - Method in class org.apache.commons.codec.net.URLCodec

Decodes a URL safe string into its original form using the default string charset.

decode(Object) - Method in class org.apache.commons.codec.net.URLCodec

Decodes a URL safe object into its original form.

decode(String) - Method in interface org.apache.commons.codec.StringDecoder

Decodes a String and returns a String.

decodeBase64(byte[]) - Static method in class org.apache.commons.codec.binary.Base64

Decodes Base64 data into octects

decodeHex(char[]) - Static method in class org.apache.commons.codec.binary.Hex

Converts an array of characters representing hexidecimal values into an array of bytes of those same values.

decodeQuotedPrintable(byte[]) - Static method in class org.apache.commons.codec.net.QuotedPrintableCodec

Decodes an array quoted-printable characters into an array of original bytes.

Decoder - Interface in org.apache.commons.codec

Provides the highest level of abstraction for Decoders.

DecoderException - Exception in org.apache.commons.codec

Thrown when a Decoder has encountered a failure condition during a decode.

DecoderException(String) - Constructor for exception org.apache.commons.codec.DecoderException

Creates a DecoderException

decodeUrl(byte[]) - Static method in class org.apache.commons.codec.net.URLCodec

Decodes an array of URL safe 7-bit characters into an array of original bytes.

difference(String, String) - Method in class org.apache.commons.codec.language.RefinedSoundex

Returns the number of characters in the two encoded Strings that are the same.

difference(String, String) - Method in class org.apache.commons.codec.language.Soundex

Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.

DigestUtils - Class in org.apache.commons.codec.digest

Operations to simplifiy common MessageDigest tasks.

DigestUtils() - Constructor for class org.apache.commons.codec.digest.DigestUtils

doDecoding(byte[]) - Method in class org.apache.commons.codec.net.BCodec

doDecoding(byte[]) - Method in class org.apache.commons.codec.net.QCodec

doEncoding(byte[]) - Method in class org.apache.commons.codec.net.BCodec

doEncoding(byte[]) - Method in class org.apache.commons.codec.net.QCodec

DoubleMetaphone - Class in org.apache.commons.codec.language

Encodes a string into a double metaphone value.

DoubleMetaphone() - Constructor for class org.apache.commons.codec.language.DoubleMetaphone

Creates an instance of this DoubleMetaphone encoder

doubleMetaphone(String) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Encode a value with Double Metaphone

doubleMetaphone(String, boolean) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Encode a value with Double Metaphone, optionally using the alternate encoding.

DoubleMetaphone.DoubleMetaphoneResult - Class in org.apache.commons.codec.language

Inner class for storing results, since there is the optional alternate encoding.

DoubleMetaphone.DoubleMetaphoneResult(int) - Constructor for class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

E

encode(Object) - Method in class org.apache.commons.codec.binary.Base64

Encodes an Object using the base64 algorithm.

encode(byte[]) - Method in class org.apache.commons.codec.binary.Base64

Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.

encode(byte[]) - Method in class org.apache.commons.codec.binary.BinaryCodec

Converts an array of raw binary data into an array of ascii 0 and 1 characters.

encode(Object) - Method in class org.apache.commons.codec.binary.BinaryCodec

Converts an array of raw binary data into an array of ascii 0 and 1 chars.

encode(byte[]) - Method in class org.apache.commons.codec.binary.Hex

Converts an array of bytes into an array of bytes for the characters representing the hexidecimal values of each byte in order.

encode(Object) - Method in class org.apache.commons.codec.binary.Hex

Converts a String or an array of bytes into an array of characters representing the hexidecimal values of each byte in order.

encode(byte[]) - Method in interface org.apache.commons.codec.BinaryEncoder

Encodes a byte array and return the encoded data as a byte array.

encode(Object) - Method in interface org.apache.commons.codec.Encoder

Encodes an "Object" and returns the encoded content as an Object.

encode(Object) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Encode the value using DoubleMetaphone.

encode(String) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Encode the value using DoubleMetaphone.

encode(Object) - Method in class org.apache.commons.codec.language.Metaphone

Encodes an Object using the metaphone algorithm.

encode(String) - Method in class org.apache.commons.codec.language.Metaphone

Encodes a String using the Metaphone algorithm.

encode(Object) - Method in class org.apache.commons.codec.language.RefinedSoundex

Encodes an Object using the refined soundex algorithm.

encode(String) - Method in class org.apache.commons.codec.language.RefinedSoundex

Encodes a String using the refined soundex algorithm.

encode(Object) - Method in class org.apache.commons.codec.language.Soundex

Encodes an Object using the soundex algorithm.

encode(String) - Method in class org.apache.commons.codec.language.Soundex

Encodes a String using the soundex algorithm.

encode(String, String) - Method in class org.apache.commons.codec.net.BCodec

Encodes a string into its Base64 form using the specified charset.

encode(String) - Method in class org.apache.commons.codec.net.BCodec

Encodes a string into its Base64 form using the default charset.

encode(Object) - Method in class org.apache.commons.codec.net.BCodec

Encodes an object into its Base64 form using the default charset.

encode(String, String) - Method in class org.apache.commons.codec.net.QCodec

Encodes a string into its quoted-printable form using the specified charset.

encode(String) - Method in class org.apache.commons.codec.net.QCodec

Encodes a string into its quoted-printable form using the default charset.

encode(Object) - Method in class org.apache.commons.codec.net.QCodec

Encodes an object into its quoted-printable form using the default charset.

encode(byte[]) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Encodes an array of bytes into an array of quoted-printable 7-bit characters.

encode(String) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Encodes a string into its quoted-printable form using the default string charset.

encode(Object) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Encodes an object into its quoted-printable safe form.

encode(String, String) - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Encodes a string into its quoted-printable form using the specified charset.

encode(byte[]) - Method in class org.apache.commons.codec.net.URLCodec

Encodes an array of bytes into an array of URL safe 7-bit characters.

encode(String, String) - Method in class org.apache.commons.codec.net.URLCodec

Encodes a string into its URL safe form using the specified string charset.

encode(String) - Method in class org.apache.commons.codec.net.URLCodec

Encodes a string into its URL safe form using the default string charset.

encode(Object) - Method in class org.apache.commons.codec.net.URLCodec

Encodes an object into its URL safe form.

encode(String) - Method in interface org.apache.commons.codec.StringEncoder

Encodes a String and returns a String.

encodeBase64(byte[]) - Static method in class org.apache.commons.codec.binary.Base64

Encodes binary data using the base64 algorithm but does not chunk the output.

encodeBase64(byte[], boolean) - Static method in class org.apache.commons.codec.binary.Base64

Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.

encodeBase64Chunked(byte[]) - Static method in class org.apache.commons.codec.binary.Base64

Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks

encodeHex(byte[]) - Static method in class org.apache.commons.codec.binary.Hex

Converts an array of bytes into an array of characters representing the hexidecimal values of each byte in order.

encodeQuotedPrintable(BitSet, byte[]) - Static method in class org.apache.commons.codec.net.QuotedPrintableCodec

Encodes an array of bytes into an array of quoted-printable 7-bit characters.

Encoder - Interface in org.apache.commons.codec

Provides the highest level of abstraction for Encoders.

EncoderException - Exception in org.apache.commons.codec

Thrown when there is a failure condition during the encoding process.

EncoderException(String) - Constructor for exception org.apache.commons.codec.EncoderException

Creates a new instance of this exception with an useful message.

encodeUrl(BitSet, byte[]) - Static method in class org.apache.commons.codec.net.URLCodec

Encodes an array of bytes into an array of URL safe 7-bit characters.

ESCAPE_CHAR - Static variable in class org.apache.commons.codec.net.URLCodec

F

fromAscii(char[]) - Static method in class org.apache.commons.codec.binary.BinaryCodec

Decodes a byte array where each char represents an ascii '0' or '1'.

fromAscii(byte[]) - Static method in class org.apache.commons.codec.binary.BinaryCodec

Decodes a byte array where each byte represents an ascii '0' or '1'.

G

getAlternate() - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

getDefaultCharset() - Method in class org.apache.commons.codec.net.BCodec

The default charset used for string decoding and encoding.

getDefaultCharset() - Method in class org.apache.commons.codec.net.QCodec

The default charset used for string decoding and encoding.

getDefaultCharset() - Method in class org.apache.commons.codec.net.QuotedPrintableCodec

Returns the default charset used for string decoding and encoding.

getDefaultCharset() - Method in class org.apache.commons.codec.net.URLCodec

The default charset used for string decoding and encoding.

getEncoding() - Method in class org.apache.commons.codec.net.BCodec

getEncoding() - Method in class org.apache.commons.codec.net.QCodec

getEncoding() - Method in class org.apache.commons.codec.net.URLCodec

Deprecated. use #getDefaultCharset()

getMaxCodeLen() - Method in class org.apache.commons.codec.language.DoubleMetaphone

Returns the maxCodeLen.

getMaxCodeLen() - Method in class org.apache.commons.codec.language.Metaphone

Returns the maxCodeLen.

getMaxLength() - Method in class org.apache.commons.codec.language.Soundex

Deprecated. This feature is not needed since the encoding size must be constant. Will be removed in 2.0.

getPrimary() - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

H

Hex - Class in org.apache.commons.codec.binary

Hex encoder and decoder.

Hex() - Constructor for class org.apache.commons.codec.binary.Hex

I

isArrayByteBase64(byte[]) - Static method in class org.apache.commons.codec.binary.Base64

Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.

isComplete() - Method in class org.apache.commons.codec.language.DoubleMetaphone.DoubleMetaphoneResult

isDoubleMetaphoneEqual(String, String) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Check if the Double Metaphone values of two String values are equal.

isDoubleMetaphoneEqual(String, String, boolean) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Check if the Double Metaphone values of two String values are equal, optionally using the alternate value.

isEncodeBlanks() - Method in class org.apache.commons.codec.net.QCodec

Tests if optional tranformation of SPACE characters is to be used

isMetaphoneEqual(String, String) - Method in class org.apache.commons.codec.language.Metaphone

Tests is the metaphones of two strings are identical.

M

maxCodeLen - Variable in class org.apache.commons.codec.language.DoubleMetaphone

Maximum length of an encoding, default is 4

md5(byte[]) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the MD5 digest and returns the value as a 16 element byte[].

md5(String) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the MD5 digest and returns the value as a 16 element byte[].

md5Hex(byte[]) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the MD5 digest and returns the value as a 32 character hex string.

md5Hex(String) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the MD5 digest and returns the value as a 32 character hex string.

Metaphone - Class in org.apache.commons.codec.language

Encodes a string into a metaphone value.

Metaphone() - Constructor for class org.apache.commons.codec.language.Metaphone

Creates an instance of the Metaphone encoder

metaphone(String) - Method in class org.apache.commons.codec.language.Metaphone

Find the metaphone value of a String.

O

org.apache.commons.codec - package org.apache.commons.codec

A small set of interfaces used by the various implementations in the sub-packages.

org.apache.commons.codec.binary - package org.apache.commons.codec.binary

Base64, Binary, and Hexadecimal String encoding and decoding.

org.apache.commons.codec.digest - package org.apache.commons.codec.digest

Operations to simplifiy common MessageDigest tasks.

org.apache.commons.codec.language - package org.apache.commons.codec.language

Language and phonetic encoders.

org.apache.commons.codec.net - package org.apache.commons.codec.net

Network related encoding and decoding.

Q

QCodec - Class in org.apache.commons.codec.net

Similar to the Quoted-Printable content-transfer-encoding defined in RFC 1521 and designed to allow text containing mostly ASCII characters to be decipherable on an ASCII terminal without decoding.

QCodec() - Constructor for class org.apache.commons.codec.net.QCodec

Default constructor.

QCodec(String) - Constructor for class org.apache.commons.codec.net.QCodec

Constructor which allows for the selection of a default charset

QuotedPrintableCodec - Class in org.apache.commons.codec.net

Codec for the Quoted-Printable section of RFC 1521 .

QuotedPrintableCodec() - Constructor for class org.apache.commons.codec.net.QuotedPrintableCodec

Default constructor.

QuotedPrintableCodec(String) - Constructor for class org.apache.commons.codec.net.QuotedPrintableCodec

Constructor which allows for the selection of a default charset

R

RefinedSoundex - Class in org.apache.commons.codec.language

Encodes a string into a Refined Soundex value.

RefinedSoundex() - Constructor for class org.apache.commons.codec.language.RefinedSoundex

Creates an instance of the RefinedSoundex object using the default US English mapping.

RefinedSoundex(char[]) - Constructor for class org.apache.commons.codec.language.RefinedSoundex

Creates a refined soundex instance using a custom mapping.

S

setEncodeBlanks(boolean) - Method in class org.apache.commons.codec.net.QCodec

Defines whether optional tranformation of SPACE characters is to be used

setMaxCodeLen(int) - Method in class org.apache.commons.codec.language.DoubleMetaphone

Sets the maxCodeLen.

setMaxCodeLen(int) - Method in class org.apache.commons.codec.language.Metaphone

Sets the maxCodeLen.

setMaxLength(int) - Method in class org.apache.commons.codec.language.Soundex

Deprecated. This feature is not needed since the encoding size must be constant. Will be removed in 2.0.

sha(byte[]) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the SHA digest and returns the value as a byte[].

sha(String) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the SHA digest and returns the value as a byte[].

shaHex(byte[]) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the SHA digest and returns the value as a hex string.

shaHex(String) - Static method in class org.apache.commons.codec.digest.DigestUtils

Calculates the SHA digest and returns the value as a hex string.

soundex(String) - Method in class org.apache.commons.codec.language.RefinedSoundex

Retreives the Refined Soundex code for a given String object.

Soundex - Class in org.apache.commons.codec.language

Encodes a string into a Soundex value.

Soundex() - Constructor for class org.apache.commons.codec.language.Soundex

Creates an instance using US_ENGLISH_MAPPING

Soundex(char[]) - Constructor for class org.apache.commons.codec.language.Soundex

Creates a soundex instance using the given mapping.

soundex(String) - Method in class org.apache.commons.codec.language.Soundex

Retreives the Soundex code for a given String object.

StringDecoder - Interface in org.apache.commons.codec

Decodes a String into a String.

StringEncoder - Interface in org.apache.commons.codec

Encodes a String into a String.

StringEncoderComparator - Class in org.apache.commons.codec

Strings are comparable, and this comparator allows you to configure it with an instance of a class which implements StringEncoder.

StringEncoderComparator() - Constructor for class org.apache.commons.codec.StringEncoderComparator

Constructs a new instance.

StringEncoderComparator(StringEncoder) - Constructor for class org.apache.commons.codec.StringEncoderComparator

Constructs a new instance with the given algorithm.

T

toAsciiBytes(byte[]) - Static method in class org.apache.commons.codec.binary.BinaryCodec

Converts an array of raw binary data into an array of ascii 0 and 1 character bytes - each byte is a truncated char.

toAsciiChars(byte[]) - Static method in class org.apache.commons.codec.binary.BinaryCodec

Converts an array of raw binary data into an array of ascii 0 and 1 characters.

toAsciiString(byte[]) - Static method in class org.apache.commons.codec.binary.BinaryCodec

Converts an array of raw binary data into a String of ascii 0 and 1 characters.

toByteArray(String) - Method in class org.apache.commons.codec.binary.BinaryCodec

Decodes a String where each char of the String represents an ascii '0' or '1'.

toDigit(char, int) - Static method in class org.apache.commons.codec.binary.Hex

Converts a hexadecimal character to an integer.

U

URLCodec - Class in org.apache.commons.codec.net

Implements the 'www-form-urlencoded' encoding scheme, also misleadingly known as URL encoding.

URLCodec() - Constructor for class org.apache.commons.codec.net.URLCodec

Default constructor.

URLCodec(String) - Constructor for class org.apache.commons.codec.net.URLCodec

Constructor which allows for the selection of a default charset

US_ENGLISH - Static variable in class org.apache.commons.codec.language.RefinedSoundex

This static variable contains an instance of the RefinedSoundex using the US_ENGLISH mapping.

US_ENGLISH - Static variable in class org.apache.commons.codec.language.Soundex

An instance of Soundex using the US_ENGLISH_MAPPING mapping.

US_ENGLISH_MAPPING - Static variable in class org.apache.commons.codec.language.RefinedSoundex

RefinedSoundex is *refined* for a number of reasons one being that the mappings have been altered.

US_ENGLISH_MAPPING - Static variable in class org.apache.commons.codec.language.Soundex

This is a default mapping of the 26 letters used in US English.

US_ENGLISH_MAPPING_STRING - Static variable in class org.apache.commons.codec.language.Soundex

This is a default mapping of the 26 letters used in US English.

W

WWW_FORM_URL - Static variable in class org.apache.commons.codec.net.URLCodec

BitSet of www-form-url safe characters.

A B C D E F G H I M O Q R S T U W