be.adaxisoft.bencode

Class BDecoder

java.lang.Object

be.adaxisoft.bencode.BDecoder

public class BDecoder
extends Object

B-encoding decoder.

A b-encoded byte stream can represent byte arrays, numbers, lists and maps (dictionaries). This class implements a decoder of such streams into BEncodedValues.

Inspired by Snark's implementation.

Author:

mpetazzoni

See Also:

B-encoding specification

Constructor Summary

Constructors

Constructor and Description
BDecoder(InputStream in) Initializes a new BDecoder.

Method Summary

Methods

Modifier and Type	Method and Description
BEncodedValue	bdecode() Gets the next indicator and returns either null when the stream has ended or b-decodes the rest of the stream and returns the appropriate BEValue encoded object.
static BEncodedValue	bdecode(ByteBuffer data) Decode a B-encoded byte buffer.
static BEncodedValue	bdecode(InputStream in) Decode a B-encoded stream.
BEncodedValue	bdecodeBytes() Returns the next b-encoded value on the stream and makes sure it is a byte array.
BEncodedValue	bdecodeList() Returns the next b-encoded value on the stream and makes sure it is a list.
BEncodedValue	bdecodeMap() Returns the next b-encoded value on the stream and makes sure it is a map (dictionary).
BEncodedValue	bdecodeNumber() Returns the next b-encoded value on the stream and makes sure it is a number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BDecoder

public BDecoder(InputStream in)

Initializes a new BDecoder.

Nothing is read from the given InputStream yet.

Parameters:

in - The input stream to read from.

Method Detail

bdecode

public static BEncodedValue bdecode(InputStream in)
                             throws IOException

Decode a B-encoded stream.

Automatically instantiates a new BDecoder for the provided input stream and decodes its root member.

Parameters:

in - The input stream to read from.

Throws:

IOException

bdecode

public static BEncodedValue bdecode(ByteBuffer data)
                             throws IOException

Decode a B-encoded byte buffer.

Automatically instantiates a new BDecoder for the provided buffer and decodes its root member.

Parameters:

data - The ByteBuffer to read from.

Throws:

IOException

bdecode

public BEncodedValue bdecode()
                      throws IOException

Gets the next indicator and returns either null when the stream has ended or b-decodes the rest of the stream and returns the appropriate BEValue encoded object.

Throws:

IOException

bdecodeBytes

public BEncodedValue bdecodeBytes()
                           throws IOException

Returns the next b-encoded value on the stream and makes sure it is a byte array.

Throws:

InvalidBEncodingException - If it is not a b-encoded byte array.

IOException

bdecodeNumber

public BEncodedValue bdecodeNumber()
                            throws IOException

Returns the next b-encoded value on the stream and makes sure it is a number.

Throws:

InvalidBEncodingException - If it is not a number.

IOException

bdecodeList

public BEncodedValue bdecodeList()
                          throws IOException

Returns the next b-encoded value on the stream and makes sure it is a list.

Throws:

InvalidBEncodingException - If it is not a list.

IOException

bdecodeMap

public BEncodedValue bdecodeMap()
                         throws IOException

Returns the next b-encoded value on the stream and makes sure it is a map (dictionary).

Throws:

InvalidBEncodingException - If it is not a map.

IOException