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

A

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

Encodes a string into a Caverphone value.

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

Creates an instance of the Caverphone encoder

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

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

Provides Base32 encoding and decoding as defined by RFC 4648.

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

Creates a Base32 codec used for decoding and encoding.

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

Creates a Base32 codec used for decoding and encoding.

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

Creates a Base32 codec used for decoding and encoding.

Base32(int, byte[]) - Constructor for class org.apache.commons.codec.binary.Base32

Creates a Base32 codec used for decoding and encoding.

Base32(int, byte[], boolean) - Constructor for class org.apache.commons.codec.binary.Base32

Creates a Base32 / Base32 Hex codec used for decoding and encoding.

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

Provides Base32 encoding and decoding in a streaming fashion (unlimited size).

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

Creates a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.

Base32InputStream(InputStream, boolean) - Constructor for class org.apache.commons.codec.binary.Base32InputStream

Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.

Base32InputStream(InputStream, boolean, int, byte[]) - Constructor for class org.apache.commons.codec.binary.Base32InputStream

Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.

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

Provides Base32 encoding and decoding in a streaming fashion (unlimited size).

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

Creates a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream.

Base32OutputStream(OutputStream, boolean) - Constructor for class org.apache.commons.codec.binary.Base32OutputStream

Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the original provided OutputStream.

Base32OutputStream(OutputStream, boolean, int, byte[]) - Constructor for class org.apache.commons.codec.binary.Base32OutputStream

Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the original provided OutputStream.

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

Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.

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

Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.

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

Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.

Base64(int, byte[]) - Constructor for class org.apache.commons.codec.binary.Base64

Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.

Base64(int, byte[], boolean) - Constructor for class org.apache.commons.codec.binary.Base64

Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.

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

Provides Base64 encoding and decoding in a streaming fashion (unlimited size).

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

Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.

Base64InputStream(InputStream, boolean) - Constructor for class org.apache.commons.codec.binary.Base64InputStream

Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original provided InputStream.

Base64InputStream(InputStream, boolean, int, byte[]) - Constructor for class org.apache.commons.codec.binary.Base64InputStream

Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original provided InputStream.

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

Provides Base64 encoding and decoding in a streaming fashion (unlimited size).

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

Creates a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream.

Base64OutputStream(OutputStream, boolean) - Constructor for class org.apache.commons.codec.binary.Base64OutputStream

Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the original provided OutputStream.

Base64OutputStream(OutputStream, boolean, int, byte[]) - Constructor for class org.apache.commons.codec.binary.Base64OutputStream

Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the original provided OutputStream.

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

Abstract superclass for Base-N encoders and decoders.

BaseNCodec(int, int, int, int) - Constructor for class org.apache.commons.codec.binary.BaseNCodec

Note lineLength is rounded down to the nearest multiple of BaseNCodec.encodedBlockSize If chunkSeparatorLength is zero, then chunking is disabled.

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

Abstract superclass for Base-N input streams.

BaseNCodecInputStream(InputStream, BaseNCodec, boolean) - Constructor for class org.apache.commons.codec.binary.BaseNCodecInputStream

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

Abstract superclass for Base-N output streams.

BaseNCodecOutputStream(OutputStream, BaseNCodec, boolean) - Constructor for class org.apache.commons.codec.binary.BaseNCodecOutputStream

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

Converts 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.

buffer - Variable in class org.apache.commons.codec.binary.BaseNCodec

Buffer for streaming.

C

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

Deprecated. 1.5 Replaced by Caverphone2, will be removed in 2.0.

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

Deprecated. Creates an instance of the Caverphone encoder

caverphone(String) - Method in class org.apache.commons.codec.language.Caverphone

Deprecated. Encodes the given String into a Caverphone value.

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

Encodes a string into a Caverphone 1.0 value.

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

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

Encodes a string into a Caverphone 2.0 value.

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

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

CharEncoding - Class in org.apache.commons.codec

Character encoding names required of every implementation of the Java platform.

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

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

The default charset used for string decoding and encoding.

close() - Method in class org.apache.commons.codec.binary.BaseNCodecOutputStream

Closes this output stream and releases any system resources associated with the stream.

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

Encodes a string into a Cologne Phonetic value.

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

colognePhonetic(String) - Method in class org.apache.commons.codec.language.ColognePhonetic

colognePhonetic() is the actual implementations of the Kölner Phonetik algorithm.

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

containsAlphabetOrPad(byte[]) - Method in class org.apache.commons.codec.binary.BaseNCodec

Tests a given byte array to see if it contains any characters within the alphabet or PAD.

currentLinePos - Variable in class org.apache.commons.codec.binary.BaseNCodec

Variable tracks how many characters have been written to the current line.

D

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

Decodes an Object using the Base-N algorithm.

decode(String) - Method in class org.apache.commons.codec.binary.BaseNCodec

Decodes a String containing characters in the Base-N alphabet.

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

Decodes a byte[] containing characters in the Base-N 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 hexadecimal 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 hexadecimal 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(String) - Static method in class org.apache.commons.codec.binary.Base64

Decodes a Base64 String into octets

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

Decodes Base64 data into octets

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

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

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

Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature

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 there is a failure condition during the decoding process.

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

Constructs a new exception with null as its detail message.

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

Constructs a new exception with the specified detail message.

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

Constructsa new exception with the specified detail message and cause.

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

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

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.

DEFAULT_CHARSET_NAME - Static variable in class org.apache.commons.codec.binary.Hex

Default charset name is CharEncoding.UTF_8

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 simplify 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.BaseNCodec

Encodes an Object using the Base-N algorithm.

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

Encodes a byte[] containing binary data, into a byte[] containing characters in the 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 hexadecimal 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 hexadecimal 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.AbstractCaverphone

Encodes an Object using the caverphone algorithm.

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

Deprecated. Encodes an Object using the caverphone algorithm.

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

Deprecated. Encodes a String using the Caverphone algorithm.

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

Encodes the given String into a Caverphone value.

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

Encodes the given String into a Caverphone 2.0 value.

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

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

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.

encodeAsString(byte[]) - Method in class org.apache.commons.codec.binary.BaseNCodec

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

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.

encodeBase64(byte[], boolean, 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.

encodeBase64(byte[], boolean, boolean, int) - 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

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

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

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

Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.

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

Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.

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

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

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

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

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

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

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

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

encodeInteger(BigInteger) - Static method in class org.apache.commons.codec.binary.Base64

Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature

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() - Constructor for exception org.apache.commons.codec.EncoderException

Constructs a new exception with null as its detail message.

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

Constructs a new exception with the specified detail message.

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

Constructs a new exception with the specified detail message and cause.

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

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

encodeToString(byte[]) - Method in class org.apache.commons.codec.binary.BaseNCodec

Encodes a byte[] containing binary data, into a String containing characters in the Base-N alphabet.

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.

ensureBufferSize(int) - Method in class org.apache.commons.codec.binary.BaseNCodec

Ensure that the buffer has room for size bytes

eof - Variable in class org.apache.commons.codec.binary.BaseNCodec

Boolean flag to indicate the EOF has been reached.

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

Release 1.5 made this field final.

F

flush() - Method in class org.apache.commons.codec.binary.BaseNCodecOutputStream

Flushes this output stream and forces any buffered output bytes to be written out to the stream.

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

Decodes a char 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

getBytesIso8859_1(String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the ISO-8859-1 charset, storing the result into a new byte array.

getBytesUnchecked(String, String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the named charset, storing the result into a new byte array.

getBytesUsAscii(String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the US-ASCII charset, storing the result into a new byte array.

getBytesUtf16(String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the UTF-16 charset, storing the result into a new byte array.

getBytesUtf16Be(String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the UTF-16BE charset, storing the result into a new byte array.

getBytesUtf16Le(String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the UTF-16LE charset, storing the result into a new byte array.

getBytesUtf8(String) - Static method in class org.apache.commons.codec.binary.StringUtils

Encodes the given string into a sequence of bytes using the UTF-8 charset, storing the result into a new byte array.

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

Gets the charset name.

getDefaultBufferSize() - Method in class org.apache.commons.codec.binary.BaseNCodec

Get the default buffer size.

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.

getEncodedLength(byte[]) - Method in class org.apache.commons.codec.binary.BaseNCodec

Calculates the amount of space needed to encode the supplied array.

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 URLCodec.getDefaultCharset(), will be removed in 2.0.

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

Converts hexadecimal Strings.

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

Creates a new codec with the default charset name Hex.DEFAULT_CHARSET_NAME

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

Creates a new codec with the given charset name.

I

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

Deprecated. 1.5 Use Base64.isBase64(byte[]), will be removed in 2.0.

isBase64(byte) - Static method in class org.apache.commons.codec.binary.Base64

Returns whether or not the octet is in the base 64 alphabet.

isBase64(String) - Static method in class org.apache.commons.codec.binary.Base64

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

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

isCaverphoneEqual(String, String) - Method in class org.apache.commons.codec.language.Caverphone

Deprecated. Tests if the caverphones of two strings are identical.

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

isEncodeEqual(String, String) - Method in class org.apache.commons.codec.language.AbstractCaverphone

Tests if the encodings of two strings are equal.

isEncodeEqual(String, String) - Method in class org.apache.commons.codec.language.ColognePhonetic

isInAlphabet(byte) - Method in class org.apache.commons.codec.binary.Base32

Returns whether or not the octet is in the Base32 alphabet.

isInAlphabet(byte) - Method in class org.apache.commons.codec.binary.Base64

Returns whether or not the octet is in the Base32 alphabet.

isInAlphabet(byte) - Method in class org.apache.commons.codec.binary.BaseNCodec

Returns whether or not the octet is in the current alphabet.

isInAlphabet(byte[], boolean) - Method in class org.apache.commons.codec.binary.BaseNCodec

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

isInAlphabet(String) - Method in class org.apache.commons.codec.binary.BaseNCodec

Tests a given String to see if it contains only valid characters within the alphabet.

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

Tests is the metaphones of two strings are identical.

ISO_8859_1 - Static variable in class org.apache.commons.codec.CharEncoding

CharEncodingISO Latin Alphabet No.

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

Returns our current encode mode.

isWhiteSpace(byte) - Static method in class org.apache.commons.codec.binary.BaseNCodec

Checks if a byte value is whitespace or not.

L

lineLength - Variable in class org.apache.commons.codec.binary.BaseNCodec

Chunksize for encoding.

M

markSupported() - Method in class org.apache.commons.codec.binary.BaseNCodecInputStream

MASK_8BITS - Static variable in class org.apache.commons.codec.binary.BaseNCodec

Mask used to extract 8 bits, used in decoding bytes

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(InputStream) - 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(InputStream) - 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.

MIME_CHUNK_SIZE - Static variable in class org.apache.commons.codec.binary.BaseNCodec

MIME chunk size per RFC 2045 section 6.8.

modulus - Variable in class org.apache.commons.codec.binary.BaseNCodec

Writes to the buffer only occur after every 3/5 reads when encoding, and every 4/8 reads when decoding.

N

newString(byte[], String) - Static method in class org.apache.commons.codec.binary.StringUtils

Constructs a new String by decoding the specified array of bytes using the given charset.

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

Constructs a new String by decoding the specified array of bytes using the ISO-8859-1 charset.

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

Constructs a new String by decoding the specified array of bytes using the US-ASCII charset.

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

Constructs a new String by decoding the specified array of bytes using the UTF-16 charset.

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

Constructs a new String by decoding the specified array of bytes using the UTF-16BE charset.

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

Constructs a new String by decoding the specified array of bytes using the UTF-16LE charset.

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

Constructs a new String by decoding the specified array of bytes using the UTF-8 charset.

O

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

Interfaces and classes used by the various implementations in the sub-packages.

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

Base64, Base32, Binary, and Hexadecimal String encoding and decoding.

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

Simplifies 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.

P

PAD - Variable in class org.apache.commons.codec.binary.BaseNCodec

PAD_DEFAULT - Static variable in class org.apache.commons.codec.binary.BaseNCodec

Byte used to pad output.

PEM_CHUNK_SIZE - Static variable in class org.apache.commons.codec.binary.BaseNCodec

PEM chunk size per RFC 1421 section 4.3.2.4.

pos - Variable in class org.apache.commons.codec.binary.BaseNCodec

Position where next character should be written in the buffer.

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

read() - Method in class org.apache.commons.codec.binary.BaseNCodecInputStream

Reads one byte from this input stream.

read(byte[], int, int) - Method in class org.apache.commons.codec.binary.BaseNCodecInputStream

Attempts to read len bytes into the specified b array starting at offset from this InputStream.

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.

RefinedSoundex(String) - 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-1 digest and returns the value as a byte[].

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

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

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

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

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

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

sha256(InputStream) - Static method in class org.apache.commons.codec.digest.DigestUtils

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

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

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

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

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

sha256Hex(InputStream) - Static method in class org.apache.commons.codec.digest.DigestUtils

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

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

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

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

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

sha384(InputStream) - Static method in class org.apache.commons.codec.digest.DigestUtils

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

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

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

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

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

sha384Hex(InputStream) - Static method in class org.apache.commons.codec.digest.DigestUtils

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

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

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

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

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

sha512(InputStream) - Static method in class org.apache.commons.codec.digest.DigestUtils

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

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

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

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

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

sha512Hex(InputStream) - Static method in class org.apache.commons.codec.digest.DigestUtils

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

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

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

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

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

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

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

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

Calculates the SHA-1 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) - Constructor for class org.apache.commons.codec.language.Soundex

Creates a refined soundex instance using a custom mapping.

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

Retrieves the Soundex code for a given String object.

StringDecoder - Interface in org.apache.commons.codec

Defines common decoding methods for String decoders.

StringEncoder - Interface in org.apache.commons.codec

Defines common encoding methods for String encoders.

StringEncoderComparator - Class in org.apache.commons.codec

Compares Strings using a StringEncoder.

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

Deprecated. Creating an instance without a StringEncoder leads to a NullPointerException. Will be removed in 2.0.

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

Constructs a new instance with the given algorithm.

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

Converts String to and from bytes using the encodings required by the Java specification.

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

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.

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

Returns a string representation of the object, which includes the charset name.

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_ASCII - Static variable in class org.apache.commons.codec.CharEncoding

Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.

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_STRING - Static variable in class org.apache.commons.codec.language.RefinedSoundex

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.

UTF_16 - Static variable in class org.apache.commons.codec.CharEncoding

Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output)

UTF_16BE - Static variable in class org.apache.commons.codec.CharEncoding

Sixteen-bit Unicode Transformation Format, big-endian byte order.

UTF_16LE - Static variable in class org.apache.commons.codec.CharEncoding

Sixteen-bit Unicode Transformation Format, little-endian byte order.

UTF_8 - Static variable in class org.apache.commons.codec.CharEncoding

Eight-bit Unicode Transformation Format.

W

write(int) - Method in class org.apache.commons.codec.binary.BaseNCodecOutputStream

Writes the specified byte to this output stream.

write(byte[], int, int) - Method in class org.apache.commons.codec.binary.BaseNCodecOutputStream

Writes len bytes from the specified b array starting at offset to this output stream.

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 L M N O P Q R S T U W