Fix checkstyle issues to enforce it

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

diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/Module.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/Module.java
index 4766ad8a47d3ce2c9ffc1a6f81ea11bf3818905a..ad4f2d36c45908e7cb3e246f662f9214ad472467 100644 (file)
--- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/Module.java
+++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/Module.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,
@@ -11,7 +11,6 @@ import javax.annotation.concurrent.NotThreadSafe;
 import org.opendaylight.controller.config.api.ModuleIdentifier;
 import org.opendaylight.yangtools.concepts.Identifiable;
 
-
 /**
  * Represents one service that is to be configured. These methods need to be
  * implemented in addition to the usual attribute getters/setters. Dependencies
@@ -19,7 +18,8 @@ import org.opendaylight.yangtools.concepts.Identifiable;
  * ConfigBeans.
  * <p>
  * In order to guide dependency resolution, the setter method should be
- * annotated with {@link org.opendaylight.controller.config.api.annotations.RequireInterface}.
+ * annotated with
+ * {@link org.opendaylight.controller.config.api.annotations.RequireInterface}.
  * </p>
  * <p>
  * Thread safety note: implementations of this interface are not required to be
@@ -27,44 +27,43 @@ import org.opendaylight.yangtools.concepts.Identifiable;
  * </p>
  */
 @NotThreadSafe
-public interface Module extends Identifiable<ModuleIdentifier>{
+public interface Module extends Identifiable<ModuleIdentifier> {
     /**
-     * This method will be called as first phase in two phase commit. Instance
-     * can check attributes, but is not allowed to do any kind of work that
-     * could leave any resources open. It is prohibited to call
-     * {@link #getInstance()} on dependent {@link Module} because it would
-     * destroy separation between validation and commit phase.
+     * This method will be called as first phase in two phase commit. Instance can
+     * check attributes, but is not allowed to do any kind of work that could leave
+     * any resources open. It is prohibited to call {@link #getInstance()} on
+     * dependent {@link Module} because it would destroy separation between
+     * validation and commit phase.
      *
      */
     void validate();
 
     /**
-     * Returns 'live' object that was configured using this object. It is
-     * allowed to call this method only after all ConfigBeans were validated. In
-     * this method new resources might be opened or old instance might be
-     * modified. This method must be implemented so that it returns same
-     * result for a single transaction. Since Module is created per transaction
-     * this means that it must be safe to cache result of first call.
+     * Returns 'live' object that was configured using this object. It is allowed to
+     * call this method only after all ConfigBeans were validated. In this method
+     * new resources might be opened or old instance might be modified. This method
+     * must be implemented so that it returns same result for a single transaction.
+     * Since Module is created per transaction this means that it must be safe to
+     * cache result of first call.
      *
      *
-     * @return closeable instance: After bundle update the factory might be able
-     *         to copy old configuration into new one without being able to cast
-     *         Module or the instance. Thus to clean up old instance, it will
-     *         call close().
+     * @return closeable instance: After bundle update the factory might be able to
+     *         copy old configuration into new one without being able to cast Module
+     *         or the instance. Thus to clean up old instance, it will call close().
      */
     AutoCloseable getInstance();
 
-
     /**
      * Compare current module with oldModule and if the instance/live object
      * produced by the old module can be reused in this module as well return true.
-     * Typically true should be returned if the old module had the same configuration.
+     * Typically true should be returned if the old module had the same
+     * configuration.
      *
      *
-     * @param oldModule old instance of Module
-     * @return true if the instance produced by oldModule can be reused with current instance as well.
+     * @param oldModule
+     *            old instance of Module
+     * @return true if the instance produced by oldModule can be reused with current
+     *         instance as well.
      */
     boolean canReuse(Module oldModule);
-
-
 }