org.johnnei.javatorrent.bittorrent.encoding

Class BencodedMap

java.lang.Object

org.johnnei.javatorrent.bittorrent.encoding.AbstractBencodedValue

org.johnnei.javatorrent.bittorrent.encoding.BencodedMap

All Implemented Interfaces:

IBencodedValue

public class BencodedMap
extends AbstractBencodedValue

A bencoded dictionary.

Constructor Summary

Constructors

Constructor and Description
BencodedMap() Creates a new empty bencoded map.

Method Summary

Modifier and Type	Method and Description
Map<String,IBencodedValue>	asMap()
Optional<IBencodedValue>	get(String name) Gets the value from the map if available.
void	put(String name, IBencodedValue value) Associates the given bencoded value with the given key.
Optional<IBencodedValue>	remove(String name) Removes a value from the map.
String	serialize()

Methods inherited from class org.johnnei.javatorrent.bittorrent.encoding.AbstractBencodedValue

asBigInteger, asList, asLong, asString

Methods inherited from class java.lang.Object

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

Constructor Detail

BencodedMap

public BencodedMap()

Creates a new empty bencoded map.

Method Detail

put

public void put(String name,
                IBencodedValue value)

Associates the given bencoded value with the given key. This will overwrite existing entries.

Parameters:

name - The key to assign the value to.

value - The value to assign.

get

public Optional<IBencodedValue> get(String name)

Gets the value from the map if available.

Parameters:

name - The key to fetch the value for.

Returns:

The value if present.

remove

public Optional<IBencodedValue> remove(String name)

Removes a value from the map.

Parameters:

name - The key to remove the value from.

Returns:

The removed value (if present).

asMap

public Map<String,IBencodedValue> asMap()

Specified by:

asMap in interface IBencodedValue

Overrides:

asMap in class AbstractBencodedValue

Returns:

The bencoded value as a map.

serialize

public String serialize()

Returns:

The value represented in bencoded format.