Fixup checkstyle 28/83828/2
authorRobert Varga <robert.varga@pantheon.tech>
Tue, 20 Aug 2019 19:04:19 +0000 (21:04 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Tue, 20 Aug 2019 21:30:57 +0000 (23:30 +0200)
Updated checkstyle does not like some our docs, fix them up.

Change-Id: I2d4f608fe9c44a56cdcac511cc1e2ae75c03b413
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java
opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/compat/ListenerMapGeneration.java
opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/md/sal/binding/test/SchemaContextSingleton.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitCoordinator.java

index 9f1a1d1..76b757b 100644 (file)
@@ -448,12 +448,13 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior {
     }
 
     @Override
-    protected RaftActorBehavior handleRequestVoteReply(final ActorRef sender,
-        final RequestVoteReply requestVoteReply) {
+    protected RaftActorBehavior handleRequestVoteReply(final ActorRef sender, final RequestVoteReply requestVoteReply) {
         return this;
     }
 
-    protected void beforeSendHeartbeat(){}
+    protected void beforeSendHeartbeat() {
+        // No-op
+    }
 
     @Override
     public RaftActorBehavior handleMessage(final ActorRef sender, final Object message) {
index 0f136d6..c1efcce 100644 (file)
@@ -28,18 +28,15 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  */
 @Deprecated
 public interface ReadTransaction extends AsyncReadTransaction<InstanceIdentifier<?>, DataObject> {
-
     /**
      * Reads data from the provided logical data store located at the provided path.
-     *<p>
-     * If the target is a subtree, then the whole subtree is read (and will be
-     * accessible from the returned data object).
      *
-     * @param store
-     *            Logical data store from which read should occur.
-     * @param path
-     *            Path which uniquely identifies subtree which client want to
-     *            read
+     * <p>
+     * If the target is a subtree, then the whole subtree is read (and will be accessible from the returned data
+     * object).
+     *
+     * @param store Logical data store from which read should occur.
+     * @param path Path which uniquely identifies subtree which client want to read
      * @return a CheckFuture containing the result of the read. The Future blocks until the
      *         commit operation is complete. Once complete:
      *         <ul>
@@ -67,11 +64,8 @@ public interface ReadTransaction extends AsyncReadTransaction<InstanceIdentifier
      * Default implementation delegates to {@link #read(LogicalDatastoreType, InstanceIdentifier)}, implementations
      * are advised to provide a more efficient override.
      *
-     * @param store
-     *            Logical data store from which read should occur.
-     * @param path
-     *            Path which uniquely identifies subtree which client want to
-     *            check existence of
+     * @param store Logical data store from which read should occur.
+     * @param path Path which uniquely identifies subtree which client want to check existence of
      * @return a CheckFuture containing the result of the check.
      *         <ul>
      *         <li>If the data at the supplied path exists, the Future returns a Boolean
index 1bd5404..3c4591a 100644 (file)
@@ -22,109 +22,92 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  */
 @Deprecated
 public interface WriteTransaction extends AsyncWriteTransaction<InstanceIdentifier<?>, DataObject> {
-
     /**
-     * Stores a piece of data at the specified path. This acts as an add / replace
-     * operation, which is to say that whole subtree will be replaced by the specified data.
-     * * <p>
+     * Stores a piece of data at the specified path. This acts as an add / replace operation, which is to say that whole
+     * subtree will be replaced by the specified data.
+     *
+     * <p>
      * This method does not automatically create missing parent nodes. It is equivalent to invoking
-     * {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
-     * with <code>createMissingParents</code> set to false.
+     * {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} with {@code createMissingParents} set
+     * to false.
+     *
      * <p>
      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+     *
      * <p>
-     * If you need to make sure that a parent object exists but you do not want modify
-     * its pre-existing state by using put, consider using {@link #merge} instead.
+     * If you need to make sure that a parent object exists but you do not want modify its pre-existing state by using
+     * put, consider using {@link #merge} instead.
      *
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be written to the specified path
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be written to the specified path
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void put(LogicalDatastoreType store, InstanceIdentifier<T> path, T data);
 
-
     /**
-     * Stores a piece of data at the specified path. This acts as an add /
-     * replace operation, which is to say that whole subtree will be replaced by
-     * the specified data.
+     * Stores a piece of data at the specified path. This acts as an add / replace operation, which is to say that whole
+     * subtree will be replaced by the specified data.
+     *
      * <p>
-     * For more information on usage and examples, please see the documentation
-     * in {@link AsyncWriteTransaction}.
+     * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+     *
      * <p>
-     * If you need to make sure that a parent object exists but you do not want
-     * modify its pre-existing state by using put, consider using {@link #merge}
-     * instead.
+     * If you need to make sure that a parent object exists but you do not want modify its pre-existing state by using
+     * put, consider using {@link #merge} instead.
      *
-     * Note: Using <code>createMissingParents</code> with value true, may
-     * introduce garbage in data store, or recreate nodes, which were deleted by
-     * previous transaction.
+     * <p>
+     * Note: Using <code>createMissingParents</code> with value true, may introduce garbage in data store, or recreate
+     * nodes, which were deleted by previous transaction.
      *
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be written to the specified path
-     * @param createMissingParents
-     *            if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing
-     *            parent nodes will be automatically created using a merge
-     *            operation.
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be written to the specified path
+     * @param createMissingParents if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing parent nodes will be
+     *                             automatically created using a merge operation.
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void put(LogicalDatastoreType store, InstanceIdentifier<T> path, T data,
             boolean createMissingParents);
 
     /**
-     * Merges a piece of data with the existing data at a specified path. Any pre-existing data
-     * which is not explicitly overwritten will be preserved. This means that if you store a container,
-     * its child lists will be merged.
+     * Merges a piece of data with the existing data at a specified path. Any pre-existing data which is not explicitly
+     * overwritten will be preserved. This means that if you store a container, its child lists will be merged.
+     *
      * <p>
      * This method does not automatically create missing parent nodes. It is equivalent to invoking
-     * {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
-     * with <code>createMissingParents</code> set to false.
+     * {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} with {@code createMissingParents}
+     * set to false.
+     *
      * <p>
      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
-     *<p>
+     *
+     * <p>
      * If you require an explicit replace operation, use {@link #put} instead.
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be merged to the specified path
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     *
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be merged to the specified path
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void merge(LogicalDatastoreType store, InstanceIdentifier<T> path, T data);
 
     /**
-     * Merges a piece of data with the existing data at a specified path. Any
-     * pre-existing data which is not explicitly overwritten will be preserved.
-     * This means that if you store a container, its child lists will be merged.
+     * Merges a piece of data with the existing data at a specified path. Any pre-existing data which is not explicitly
+     * overwritten will be preserved. This means that if you store a container, its child lists will be merged.
+     *
      * <p>
-     * For more information on usage and examples, please see the documentation
-     * in {@link AsyncWriteTransaction}.
+     * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+     *
      * <p>
      * If you require an explicit replace operation, use {@link #put} instead.
      *
-     * @param store
-     *            the logical data store which should be modified
-     * @param path
-     *            the data object path
-     * @param data
-     *            the data object to be merged to the specified path
-     * @param createMissingParents
-     *            if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing
-     *            parent nodes will be automatically created using a merge
-     *            operation.
-     * @throws IllegalStateException
-     *             if the transaction has already been submitted
+     * @param store the logical data store which should be modified
+     * @param path the data object path
+     * @param data the data object to be merged to the specified path
+     * @param createMissingParents if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing parent nodes will be
+     *                             automatically created using a merge operation.
+     * @throws IllegalStateException if the transaction has already been submitted
      */
     <T extends DataObject> void merge(LogicalDatastoreType store, InstanceIdentifier<T> path, T data,
             boolean createMissingParents);
index d6978d7..cd70e4c 100644 (file)
@@ -25,11 +25,10 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService
      * Returns an implementation of a requested RPC service.
      *
      * <p>
-     * The returned instance is not an actual implementation of the RPC service
-     * interface, but a proxy implementation of the interface that forwards to
-     * an actual implementation, if any.
-     * <p>
+     * The returned instance is not an actual implementation of the RPC service interface, but a proxy implementation
+     * of the interface that forwards to an actual implementation, if any.
      *
+     * <p>
      * The following describes the behavior of the proxy when invoking RPC methods:
      * <ul>
      * <li>If an actual implementation is registered with the MD-SAL, all invocations are
@@ -40,9 +39,8 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService
      * If any are invalid, an {@link IllegalArgumentException} is thrown.
      * </ul>
      *
-     * The returned proxy is automatically updated with the most recent
-     * registered implementation.
-     *
+     * <p>
+     * The returned proxy is automatically updated with the most recent registered implementation.
      * {@code
      *   final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
      *   Futures.addCallback(future,
index 367e55d..3e05f17 100644 (file)
@@ -257,8 +257,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  * @deprecated Use {@link org.opendaylight.mdsal.binding.api.RpcProviderService} instead
  */
 @Deprecated
-public interface RpcProviderRegistry extends //
-        RpcConsumerRegistry, //
+public interface RpcProviderRegistry extends RpcConsumerRegistry,
         RouteChangePublisher<RpcContextIdentifier, InstanceIdentifier<?>> {
     /**
      * Registers a global implementation of the provided RPC service interface.
@@ -277,9 +276,9 @@ public interface RpcProviderRegistry extends //
 
     /**
      * Registers an implementation of the given routed RPC service interface.
+     *
      * <p>
-     * See the {@link RpcProviderRegistry class} documentation for information and example on
-     * how to use routed RPCs.
+     * See the {@link RpcProviderRegistry class} documentation for information and example on how to use routed RPCs.
      *
      * @param serviceInterface the YANG-generated interface of the RPC Service for which to register.
      * @param implementation the implementation instance to register.
@@ -287,11 +286,8 @@ public interface RpcProviderRegistry extends //
      *         implementation via invoking RoutedRpcRegistration#registerPath(Class, InstanceIdentifer).
      *         {@link RoutedRpcRegistration#close()} should be called to unregister the implementation
      *         and all previously registered paths when no longer needed.
-     *
-     * @throws IllegalStateException
-     *            if the supplied RPC interface is not a routed RPC type.
+     * @throws IllegalStateException if the supplied RPC interface is not a routed RPC type.
      */
     <T extends RpcService> RoutedRpcRegistration<T> addRoutedRpcImplementation(Class<T> serviceInterface,
-                                                                               T implementation)
-            throws IllegalStateException;
+            T implementation) throws IllegalStateException;
 }
index 3848c88..48be277 100644 (file)
@@ -22,17 +22,14 @@ import org.opendaylight.yangtools.concepts.Path;
  */
 @Deprecated
 public interface AsyncConfigurationCommitCoordinator<P extends Path<P>, D> {
-
     /**
-     * Register configuration commit handler for particular subtree.
-     *
-     * Configuration commit handler is invoked for all write transactions
-     * which modifies <code>subtree</code>
+     * Register configuration commit handler for particular subtree. Configuration commit handler is invoked for all
+     * write transactions which modifies <code>subtree</code>
      *
      * @param subtree Subtree which configuration commit handler is interested it
      * @param commitHandler Instance of user-provided commit handler
      * @return Registration object representing this registration. Invoking {@link ObjectRegistration#close()}
-     *   will unregister configuration commit handler.
+     *         will unregister configuration commit handler.
      */
     <C extends AsyncConfigurationCommitCohort<P, D>> ObjectRegistration<C> registerConfigurationCommitHandler(
             P subtree, C commitHandler);

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.