io.ipfs.api

Interface IpldNode

All Superinterfaces:

Cborable

All Known Implementing Classes:

IpldNode.CborIpldNode, IpldNode.JsonIpldNode

public interface IpldNode
extends Cborable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IpldNode.CborIpldNode
static class	IpldNode.JsonIpldNode
static class	IpldNode.Link

Method Summary

Modifier and Type	Method and Description
default io.ipfs.cid.Cid	cid()
static IpldNode	fromCBOR(CborObject cbor)
static IpldNode	fromJSON(java.lang.Object json)
java.util.List<IpldNode.Link>	getLinks()
byte[]	rawData()
Pair<IpldNode,java.util.List<java.lang.String>>	resolve(java.util.List<java.lang.String> path)
long	size()
java.util.List<java.lang.String>	tree(java.lang.String path, int depth) Lists all paths within the object under 'path', and up to the given depth.

Methods inherited from interface io.ipfs.api.cbor.Cborable

serialize, toCbor

Method Detail

resolve

Pair<IpldNode,java.util.List<java.lang.String>> resolve(java.util.List<java.lang.String> path)

tree

java.util.List<java.lang.String> tree(java.lang.String path,
                                      int depth)

Lists all paths within the object under 'path', and up to the given depth. To list the entire object (similar to `find .`) pass "" and -1

Parameters:

path -

depth -

Returns:

cid

default io.ipfs.cid.Cid cid()

Returns:

calculate this objects Cid

size

long size()

Returns:

size of this object when encoded

rawData

byte[] rawData()

Returns:

this object's serialization

getLinks

java.util.List<IpldNode.Link> getLinks()

Returns:

the merkle links from this object

fromCBOR

static IpldNode fromCBOR(CborObject cbor)

fromJSON

static IpldNode fromJSON(java.lang.Object json)