Fix checkstyle issues to enforce it

[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / ConfigTransactionController.java

diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigTransactionController.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigTransactionController.java
index 264751318c3570415f412a82b4df7d992853c451..c234da7df590c0743e4be3e3b916a365bc7a59d9 100644 (file)
--- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigTransactionController.java
+++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigTransactionController.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2013, 2017 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -8,7 +8,6 @@
 package org.opendaylight.controller.config.api;
 
 import java.util.Set;
-
 import javax.management.InstanceAlreadyExistsException;
 import javax.management.InstanceNotFoundException;
 import javax.management.ObjectName;
@@ -22,13 +21,28 @@ public interface ConfigTransactionController extends LookupRegistry, ServiceRefe
      * Create new configuration bean.
      *
      * @param moduleName
+     *            name of the module
      * @param instanceName
+     *            name of the instance
      * @return ObjectName of newly created module
      * @throws InstanceAlreadyExistsException
      *             if given ifcName and instanceName is already registered
      */
-    ObjectName createModule(String moduleName, String instanceName)
-            throws InstanceAlreadyExistsException;
+    ObjectName createModule(String moduleName, String instanceName) throws InstanceAlreadyExistsException;
+
+    /**
+     * Re-creates an existing module configuration bean.
+     *
+     * @param objectName
+     *            can be either read-only module name that can be obtained using
+     *            {@link ConfigRegistry#lookupConfigBean(String, String)} or
+     *            writable module name that must contain current transaction name.
+     * @throws InstanceNotFoundException
+     *             if module is not found
+     * @throws IllegalArgumentException
+     *             if object name contains wrong transaction name or domain
+     */
+    void reCreateModule(ObjectName objectName) throws InstanceNotFoundException;
 
     /**
      * Destroy existing module.
@@ -36,8 +50,7 @@ public interface ConfigTransactionController extends LookupRegistry, ServiceRefe
      * @param objectName
      *            can be either read-only module name that can be obtained using
      *            {@link ConfigRegistry#lookupConfigBean(String, String)} or
-     *            writable module name that must contain current transaction
-     *            name.
+     *            writable module name that must contain current transaction name.
      * @throws InstanceNotFoundException
      *             if module is not found
      * @throws IllegalArgumentException
@@ -59,14 +72,17 @@ public interface ConfigTransactionController extends LookupRegistry, ServiceRefe
     void validateConfig() throws ValidationException;
 
     /**
+     * Get the name of the transaction.
      *
      * @return transactionName
      */
     String getTransactionName();
 
     /**
-     * @return all known module factory names as reported by {@link org.opendaylight.controller.config.spi.ModuleFactory#getImplementationName()}
+     * Get the names of all available modules.
+     *
+     * @return all known module factory names as reported by
+     *         {@link org.opendaylight.controller.config.spi.ModuleFactory#getImplementationName()}
      */
     Set<String> getAvailableModuleNames();
-
 }