Added documentation regarding method intended use-case

This commit is contained in:
Collin Smith 2020-09-02 16:19:58 -07:00
parent 251a691bd5
commit ca170f7cfb

View File

@ -47,12 +47,18 @@ public class StatListReader {
return stats.get();
}
/**
* Reads a single property list into {@link Attributes#base()}
*/
public StatListGetter read(Attributes attrs, BitInput bits) {
final StatList stats = attrs.base().clear();
final StatListBuilder builder = stats.buildList();
return read(builder, bits);
}
/**
* Reads property lists into {@link Attributes#list()}
*/
public StatList read(Attributes attrs, BitInput bits, int flags, int maxLists) {
final StatList stats = attrs.list().clear();
for (int i = 0; i < maxLists; i++) {