-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpackage-info.java
More file actions
30 lines (30 loc) · 1019 Bytes
/
package-info.java
File metadata and controls
30 lines (30 loc) · 1019 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
* Provides the codec registry and predefined codec sets for the
* <a href="https://github.com/multiformats/multicodec">multicodec</a> format.
*
* <p>
* The {@code codec} subpackage contains the
* {@link com.apicatalog.multicodec.codec.MulticodecRegistry}, which maintains
* mappings between multicodec codes and their
* {@link com.apicatalog.multicodec.Multicodec} definitions. It supports
* creating registry instances containing:
* </p>
*
* <ul>
* <li>All known codecs ({@code MulticodecRegistry.getInstance()})</li>
* <li>Only codecs matching specific
* {@link com.apicatalog.multicodec.Multicodec.Tag}s</li>
* <li>Only explicitly provided codecs</li>
* </ul>
*
* <h2>Usage Example</h2>
*
* <pre>{@code
* // registry with all known codecs
* MulticodecRegistry registry = MulticodecRegistry.getInstance();
*
* // registry with only a subset of codecs by tag
* MulticodecRegistry hashes = MulticodecRegistry.getInstance(Tag.Hash);
* }</pre>
*/
package com.apicatalog.multicodec.codec;