com.dampcake.bencode

Class Bencode

java.lang.Object

com.dampcake.bencode.Bencode

public final class Bencode
extends Object

Bencode encoder/decoder.

Since:

1.1

Author:

Adam Peck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Bencode.ThrowingConsumer<T>

Constructor Summary

Constructors

Constructor and Description
Bencode() Create a new Bencoder using the default Charset (UTF-8) and useBytes as false.
Bencode(boolean useBytes) Creates a new Bencoder using the boolean passed to control String parsing.
Bencode(Charset charset) Creates a new Bencoder using the Charset passed for encoding/decoding and useBytes as false.
Bencode(Charset charset, boolean useBytes) Creates a new Bencoder using the Charset passed for encoding/decoding and boolean passed to control String parsing.

Method Summary

Modifier and Type	Method and Description
<T> T	decode(byte[] bytes, Type<T> type) Decodes a bencode encoded byte array.
byte[]	encode(Iterable<?> l) Encodes the passed Iterable as a bencode List.
byte[]	encode(Map<?,?> m) Encodes the passed Map as a bencode Dictionary.
byte[]	encode(Number n) Encodes the passed Number.
byte[]	encode(String s) Encodes the passed String.
Charset	getCharset() Gets the Charset the coder was created with.
Type	type(byte[] bytes) Determines the first Type contained within the byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bencode

public Bencode()

Create a new Bencoder using the default Charset (UTF-8) and useBytes as false.

See Also:

Bencode(Charset, boolean)

Bencode

public Bencode(Charset charset)

Creates a new Bencoder using the Charset passed for encoding/decoding and useBytes as false.

Parameters:

charset - the Charset to use

Throws:

NullPointerException - if the Charset passed is null

See Also:

Bencode(Charset, boolean)

Bencode

public Bencode(boolean useBytes)

Creates a new Bencoder using the boolean passed to control String parsing.

Parameters:

useBytes - Bencode(Charset, boolean)

Since:

1.3

Bencode

public Bencode(Charset charset,
               boolean useBytes)

Creates a new Bencoder using the Charset passed for encoding/decoding and boolean passed to control String parsing. If useBytes is false, then dictionary values that contain byte string data will be coerced to a String. if useBytes is true, then dictionary values that contain byte string data will be coerced to a ByteBuffer.

Parameters:

charset - the Charset to use

useBytes - true to have dictionary byte data to stay as bytes

Throws:

NullPointerException - if the Charset passed is null

Since:

1.3

Method Detail

getCharset

public Charset getCharset()

Gets the Charset the coder was created with.

Returns:

the Charset of the coder

type

public Type type(byte[] bytes)

Determines the first Type contained within the byte array.

Parameters:

bytes - the bytes to determine the Type for

Returns:

the Type or Type.UNKNOWN if it cannot be determined

Throws:

NullPointerException - if bytes is null

BencodeException - if an error occurs during detection

decode

public <T> T decode(byte[] bytes,
                    Type<T> type)

Decodes a bencode encoded byte array.

Type Parameters:

T - inferred from the Type parameter

Parameters:

bytes - the bytes to decode

type - the Type to decode as

Returns:

the decoded object

Throws:

NullPointerException - if bytes or type is null

IllegalArgumentException - if type is Type.UNKNOWN

BencodeException - if an error occurs during decoding

encode

public byte[] encode(String s)

Encodes the passed String.

Parameters:

s - the String to encode

Returns:

the encoded bytes

Throws:

NullPointerException - if the String is null

BencodeException - if an error occurs during encoding

encode

public byte[] encode(Number n)

Encodes the passed Number.

The number is converted to a Long, meaning any precision is lost as it not supported by the bencode spec.

Parameters:

n - the Number to encode

Returns:

the encoded bytes

Throws:

NullPointerException - if the Number is null

BencodeException - if an error occurs during encoding

encode

public byte[] encode(Iterable<?> l)

Encodes the passed Iterable as a bencode List.

Data contained in the List is written as the correct type. Any Iterable is written as a List, any Number as a Number, any Map as a Dictionary and any other Object is written as a String calling the Object.toString() method.

Parameters:

l - the Iterable to encode

Returns:

the encoded bytes

Throws:

NullPointerException - if the List is null

BencodeException - if an error occurs during encoding

encode

public byte[] encode(Map<?,?> m)

Encodes the passed Map as a bencode Dictionary.

Data contained in the Dictionary is written as the correct type. Any Iterable is written as a List, any Number as a Number, any Map as a Dictionary and any other Object is written as a String calling the Object.toString() method.

Parameters:

m - the Map to encode

Returns:

the encoded bytes

Throws:

NullPointerException - if the Map is null

BencodeException - if an error occurs during encoding