Update StatementMap javadocs 93/98993/1
authorRobert Varga <robert.varga@pantheon.tech>
Tue, 14 Dec 2021 21:23:20 +0000 (22:23 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Tue, 14 Dec 2021 21:23:53 +0000 (22:23 +0100)
We have two undocumented methods, add javadocs.

Change-Id: I5aff94d5e2826bdc1718a725fec23403feab34d9
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementMap.java

index 36d1586d64ce44c1eb17eaf8af5a159132a1c0f0..6441ded70dd9e5e5f6f79803f13abfec348845f7 100644 (file)
@@ -197,6 +197,11 @@ abstract class StatementMap extends AbstractCollection<AbstractResumedStatement<
 
     private static final @NonNull StatementMap EMPTY = new Empty();
 
+    /**
+     * Return an empty map.
+     *
+     * @return An empty map.
+     */
     static @NonNull StatementMap empty() {
         return EMPTY;
     }
@@ -219,5 +224,11 @@ abstract class StatementMap extends AbstractCollection<AbstractResumedStatement<
      */
     abstract @NonNull StatementMap put(int index, @NonNull AbstractResumedStatement<?, ?, ?> obj);
 
+    /**
+     * Ensure storage space for at least {@code explectedLimit} substatements.
+     *
+     * @param expectedLimit Expected number of substatements
+     * @return New statement map
+     */
     abstract @NonNull StatementMap ensureCapacity(int expectedLimit);
 }