Package org.bouncycastle.util.encoders

Interface Encoder

All Known Implementing Classes:

Base32Encoder, Base64Encoder, HexEncoder, UrlBase64Encoder

public interface Encoder

Encode and decode byte arrays (typically from binary to 7-bit ASCII encodings).

Method Summary

Modifier and Type	Method	Description
int	decode(byte[] data, int off, int length, OutputStream out)
int	decode(String data, OutputStream out)
int	encode(byte[] data, int off, int length, OutputStream out)
int	getEncodedLength(int inputLength)	Return the expected output length of the encoding.
int	getMaxDecodedLength(int inputLength)	Return the maximum expected output length of a decoding.

Method Details

getEncodedLength

int getEncodedLength(int inputLength)

Return the expected output length of the encoding.

Parameters:

inputLength - the input length of the data.

Returns:

the output length of an encoding.

getMaxDecodedLength

int getMaxDecodedLength(int inputLength)

Return the maximum expected output length of a decoding. If padding is present the value returned will be greater than the decoded data length.

Parameters:

inputLength - the input length of the encoded data.

Returns:

the upper bound of the output length of a decoding.

encode

int encode(byte[] data,
 int off,
 int length,
 OutputStream out)
    throws IOException

Throws:

IOException

decode

int decode(byte[] data,
 int off,
 int length,
 OutputStream out)
    throws IOException

Throws:

IOException

decode

int decode(String data,
 OutputStream out)
    throws IOException

Throws:

IOException