Cleanup AbstractBindingRuntimeContext.getAvailableAugmentationTypes()

[mdsal.git] / binding / mdsal-binding-runtime-api / src / main / java / org / opendaylight / mdsal / binding / runtime / api / BindingRuntimeContext.java

diff --git a/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeContext.java b/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeContext.java
index 5ee85731b139e4f72acbef10ed263512ab57f4e3..66830d30e5a175960248920d90ff7b46519f55dd 100644 (file)
--- a/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeContext.java
+++ b/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeContext.java
@@ -134,6 +134,14 @@ public interface BindingRuntimeContext extends EffectiveModelContextProvider, Im
 
     @NonNull Class<?> getClassForSchema(SchemaNode childSchema);
 
+    /**
+     * Return the mapping of a particular {@link DataNodeContainer}'s available augmentations. This method deals with
+     * resolving {@code uses foo { augment bar { ... } } } scenarios by returning the augmentation created for
+     * {@code grouping foo}'s Binding representation.
+     *
+     * @param container {@link DataNodeContainer} to examine
+     * @return a mapping from local {@link AugmentationIdentifier}s to their corresponding Binding augmentations
+     */
     @NonNull ImmutableMap<AugmentationIdentifier, Type> getAvailableAugmentationTypes(DataNodeContainer container);
 
     @NonNull Class<?> getIdentityClass(QName input);