org.apache.ws.commons.util

Class Base64.Encoder

Enclosing Class:
Base64

public static abstract class Base64.Encoder
extends java.lang.Object

An encoder is an object, which is able to encode byte array in blocks of three bytes. Any such block is converted into an array of four bytes.

Constructor Summary

Encoder(char[] pBuffer, int pWrapSize, String pSep)
Creates a new instance.

Method Summary

void
flush()
Writes any currently buffered data to the destination.
void
write(byte[] pBuffer, int pOffset, int pLen)
Encodes the given byte array.
protected abstract void
writeBuffer(char[] pChars, int pOffset, int pLen)
Called for writing the buffer contents to the target.

Constructor Details

Encoder

protected Encoder(char[] pBuffer,
                  int pWrapSize,
                  String pSep)
Creates a new instance.
Parameters:
pBuffer - The encoders buffer. The encoder will write to the buffer as long as possible. If the buffer is full or the end of data is signaled, then the method writeBuffer(char[],int,int) will be invoked.
pWrapSize - A nonzero value indicates, that a line wrap should be performed after the given number of characters. The value must be a multiple of 4. Zero indicates, that no line wrap should be performed.
pSep - The eol sequence being used to terminate a line in case of line wraps. May be null, in which case the default value Base64.LINE_SEPARATOR is being used.

Method Details

flush

public void flush()
            throws IOException
Writes any currently buffered data to the destination.

write

public void write(byte[] pBuffer,
                  int pOffset,
                  int pLen)
            throws IOException
Encodes the given byte array.
Parameters:
pBuffer - Byte array being encoded.
pOffset - Offset of first byte being encoded.
pLen - Number of bytes being encoded.

writeBuffer

protected abstract void writeBuffer(char[] pChars,
                                    int pOffset,
                                    int pLen)
            throws IOException
Called for writing the buffer contents to the target.
Parameters:
pChars - The buffer being written.
pOffset - Offset of first character being written.
pLen - Number of characters being written.