Package net.dv8tion.jda.api.utils.data.etf

Class ExTermDecoder

java.lang.Object

net.dv8tion.jda.api.utils.data.etf.ExTermDecoder

public class ExTermDecoder
extends Object

Decodes an ETF encoded payload to a java object representation.

Since:

4.2.1

See Also:

• unpack(ByteBuffer)
• unpackMap(ByteBuffer)
• unpackList(ByteBuffer)

Constructor Summary

Constructors

Constructor	Description
ExTermDecoder()

Method Summary

Modifier and Type	Method	Description
static Object	unpack(ByteBuffer buffer)	Unpacks the provided term into a java object.
static List<Object>	unpackList(ByteBuffer buffer)	Unpacks the provided term into a java List.
static Map<String,Object>	unpackMap(ByteBuffer buffer)	Unpacks the provided term into a java Map.

Methods inherited from class java.lang.Object

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

Constructor Details

ExTermDecoder

public ExTermDecoder()

Method Details

unpack

@Nonnull
public static Object unpack(ByteBuffer buffer)

Unpacks the provided term into a java object.

The mapping is as follows:

• Small Int | Int -> Integer
• Small BigInt -> Long
• Float | New Float -> Double
• Small Atom | Atom -> Boolean | null | String
• Binary | String -> String
• List | NIL -> List
• Map -> Map

Parameters:

buffer - The ByteBuffer containing the encoded term

Returns:

The java object

Throws:

IllegalArgumentException - If the buffer does not start with the version byte 131 or contains an unsupported tag

unpackMap

@Nonnull
public static Map<String,Object> unpackMap(ByteBuffer buffer)

Unpacks the provided term into a java Map.

The mapping is as follows:

• Small Int | Int -> Integer
• Small BigInt -> Long
• Float | New Float -> Double
• Small Atom | Atom -> Boolean | null | String
• Binary | String -> String
• List | NIL -> List
• Map -> Map

Parameters:

buffer - The ByteBuffer containing the encoded term

Returns:

The parsed Map instance

Throws:

IllegalArgumentException - If the buffer does not start with a Map term, does not have the right version byte, or the format includes an unsupported tag

unpackList

@Nonnull
public static List<Object> unpackList(ByteBuffer buffer)

Unpacks the provided term into a java List.

The mapping is as follows:

• Small Int | Int -> Integer
• Small BigInt -> Long
• Float | New Float -> Double
• Small Atom | Atom -> Boolean | null | String
• Binary | String -> String
• List | NIL -> List
• Map -> Map

Parameters:

buffer - The ByteBuffer containing the encoded term

Returns:

The parsed List instance

Throws:

IllegalArgumentException - If the buffer does not start with a List or NIL term, does not have the right version byte, or the format includes an unsupported tag