Interface Decoder

  • All Known Implementing Classes:
    Base64Decoder, PackBitsDecoder

    public interface Decoder
    Interface for decoders. A Decoder may be used with a DecoderStream, to perform on-the-fly decoding from an InputStream.

    Important note: Decoder implementations are typically not synchronized.

    Version:
    $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Decoder.java#2 $
    Author:
    Harald Kuhr
    See Also:
    Encoder, DecoderStream
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int decode​(java.io.InputStream stream, java.nio.ByteBuffer buffer)
      Decodes up to buffer.length bytes from the given input stream, into the given buffer.
    • Method Detail

      • decode

        int decode​(java.io.InputStream stream,
                   java.nio.ByteBuffer buffer)
            throws java.io.IOException
        Decodes up to buffer.length bytes from the given input stream, into the given buffer.
        Parameters:
        stream - the input stream to decode data from
        buffer - buffer to store the read data
        Returns:
        the total number of bytes read into the buffer, or 0 if there is no more data because the end of the stream has been reached.
        Throws:
        DecodeException - if encoded data is corrupt.
        java.io.IOException - if an I/O error occurs.
        java.io.EOFException - if a premature end-of-file is encountered.
        java.lang.NullPointerException - if either argument is null.