Fix checkstyle issues to enforce it
[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / ServiceReferenceReadableRegistry.java
index a364e54bff584363405b2b88337b65301a000add..f4ee78784fd93c35672aa1b2b32411ca67c7343b 100644 (file)
@@ -15,11 +15,17 @@ import javax.management.ObjectName;
 public interface ServiceReferenceReadableRegistry {
 
     /**
-     * Lookup object name by fully qualified service interface name and service reference name.
-     * @param serviceInterfaceQName service interface name
-     * @param refName service reference name supplied in
-     * {@link org.opendaylight.controller.config.api.ConfigTransactionController#saveServiceReference(String, String, javax.management.ObjectName)}
-     * @throws java.lang.IllegalArgumentException if module not found
+     * Lookup object name by fully qualified service interface name and service
+     * reference name.
+     *
+     * @param serviceInterfaceQName
+     *            service interface name
+     * @param refName
+     *            service reference name supplied in
+     *            {@link org.opendaylight.controller.config
+     *            .api .ConfigTransactionController#saveServiceReference(String, String, javax.management.ObjectName)}
+     * @throws java.lang.IllegalArgumentException
+     *             if module not found
      */
     ObjectName lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName, String refName);
 
@@ -29,34 +35,50 @@ public interface ServiceReferenceReadableRegistry {
     Map<String /* serviceInterfaceQName */, Map<String/* refName */, ObjectName>> getServiceMapping();
 
     /**
-     * Get current mapping between reference names and module object names for given service interface name.
-     * @param serviceInterfaceQName service interface name
-     * @throws IllegalArgumentException if there is a mismatch between serviceInterfaceName and objectName
+     * Get current mapping between reference names and module object names for given
+     * service interface name.
+     *
+     * @param serviceInterfaceQName
+     *            service interface name
+     * @throws IllegalArgumentException
+     *             if there is a mismatch between serviceInterfaceName and
+     *             objectName
      */
     Map<String /* refName */, ObjectName> lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceQName);
 
     /**
      * Find all available service interface names of a module.
-     * @param objectName module object name
-     * @throws InstanceNotFoundException if search did not find exactly one instance
+     *
+     * @param objectName
+     *            module object name
+     * @throws InstanceNotFoundException
+     *             if search did not find exactly one instance
      */
     Set<String> lookupServiceInterfaceNames(ObjectName objectName) throws InstanceNotFoundException;
 
     /**
-     * @param namespace service interface namespace
-     * @param localName service interface local name
-     * @return fully qualified name needed by all other service reference mapping methods.
-     * @throws java.lang.IllegalArgumentException if namespace or localName is not found
+     * Get the name of the service interface.
+     *
+     * @param namespace
+     *            service interface namespace
+     * @param localName
+     *            service interface local name
+     * @return fully qualified name needed by all other service reference mapping
+     *         methods.
+     * @throws java.lang.IllegalArgumentException
+     *             if namespace or localName is not found
      */
     String getServiceInterfaceName(String namespace, String localName);
 
     /**
+     * Get the reference to that service.
+     *
      * @return ObjectName with type=Service that was created using
-     * {@link org.opendaylight.controller.config.api.ServiceReferenceWritableRegistry#saveServiceReference(String, String,
-     * javax.management.ObjectName)}
+     *         {@link org.opendaylight.controller
+     *         .config .api.ServiceReferenceWritableRegistry#saveServiceReference(String,
+     *          String, javax.management.ObjectName)}
      */
     ObjectName getServiceReference(String serviceInterfaceQName, String refName) throws InstanceNotFoundException;
 
     void checkServiceReferenceExists(ObjectName objectName) throws InstanceNotFoundException;
-
 }