From aa1c4a51361239aeaa064eb11eb935be194b6eeb Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Tue, 20 Aug 2019 21:04:19 +0200 Subject: [PATCH] Fixup checkstyle Updated checkstyle does not like some our docs, fix them up. Change-Id: I2d4f608fe9c44a56cdcac511cc1e2ae75c03b413 Signed-off-by: Robert Varga --- .../raft/behaviors/AbstractLeader.java | 7 +- .../md/sal/binding/api/ReadTransaction.java | 22 ++- .../md/sal/binding/api/WriteTransaction.java | 125 ++++++++---------- .../sal/binding/api/RpcConsumerRegistry.java | 12 +- .../sal/binding/api/RpcProviderRegistry.java | 14 +- .../binding/compat/ListenerMapGeneration.java | 2 +- .../binding/test/SchemaContextSingleton.java | 4 +- .../AsyncConfigurationCommitCoordinator.java | 9 +- 8 files changed, 83 insertions(+), 112 deletions(-) diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java index 9f1a1d13f9..76b757be37 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java @@ -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) { diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java index 0f136d6043..c1efcce02c 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java @@ -28,18 +28,15 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; */ @Deprecated public interface ReadTransaction extends AsyncReadTransaction, DataObject> { - /** * Reads data from the provided logical data store located at the provided path. - *

- * 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 + *

+ * 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: *

    @@ -67,11 +64,8 @@ public interface ReadTransaction extends AsyncReadTransaction *
  • If the data at the supplied path exists, the Future returns a Boolean diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java index 1bd5404f70..3c4591a0a3 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java @@ -22,109 +22,92 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; */ @Deprecated public interface WriteTransaction extends AsyncWriteTransaction, 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. - * *

    + * 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. + * + *

    * This method does not automatically create missing parent nodes. It is equivalent to invoking - * {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} - * with createMissingParents set to false. + * {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} with {@code createMissingParents} set + * to false. + * *

    * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}. + * *

    - * 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 */ void put(LogicalDatastoreType store, InstanceIdentifier 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. + * *

    - * 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}. + * *

    - * 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 createMissingParents with value true, may - * introduce garbage in data store, or recreate nodes, which were deleted by - * previous transaction. + *

    + * Note: Using createMissingParents 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 */ void put(LogicalDatastoreType store, InstanceIdentifier 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. + * *

    * This method does not automatically create missing parent nodes. It is equivalent to invoking - * {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} - * with createMissingParents set to false. + * {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)} with {@code createMissingParents} + * set to false. + * *

    * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}. - *

    + * + *

    * 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 */ void merge(LogicalDatastoreType store, InstanceIdentifier 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. + * *

    - * 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}. + * *

    * 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 */ void merge(LogicalDatastoreType store, InstanceIdentifier path, T data, boolean createMissingParents); diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java index d6978d73d1..cd70e4c852 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java @@ -25,11 +25,10 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService * Returns an implementation of a requested RPC service. * *

    - * 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. - *

    + * 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. * + *

    * The following describes the behavior of the proxy when invoking RPC methods: *

      *
    • 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. *
    * - * The returned proxy is automatically updated with the most recent - * registered implementation. - * + *

    + * The returned proxy is automatically updated with the most recent registered implementation. * {@code * final Future> future = someRpcService.someRpc( ... ); * Futures.addCallback(future, diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java index 367e55d927..3e05f17238 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java @@ -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> { /** * 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. + * *

    - * 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. */ RoutedRpcRegistration addRoutedRpcImplementation(Class serviceInterface, - T implementation) - throws IllegalStateException; + T implementation) throws IllegalStateException; } diff --git a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/compat/ListenerMapGeneration.java b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/compat/ListenerMapGeneration.java index 3a392e58cc..ef1639cfaf 100644 --- a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/compat/ListenerMapGeneration.java +++ b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/compat/ListenerMapGeneration.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the diff --git a/opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/md/sal/binding/test/SchemaContextSingleton.java b/opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/md/sal/binding/test/SchemaContextSingleton.java index 32f84a8508..06763bc2a1 100644 --- a/opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/md/sal/binding/test/SchemaContextSingleton.java +++ b/opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/md/sal/binding/test/SchemaContextSingleton.java @@ -31,7 +31,9 @@ public final class SchemaContextSingleton { return staticSchemaContext; } - private SchemaContextSingleton() { } + private SchemaContextSingleton() { + + } @FunctionalInterface public interface Supplier { diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitCoordinator.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitCoordinator.java index 3848c88cfe..48be277b7e 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitCoordinator.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitCoordinator.java @@ -22,17 +22,14 @@ import org.opendaylight.yangtools.concepts.Path; */ @Deprecated public interface AsyncConfigurationCommitCoordinator

    , D> { - /** - * Register configuration commit handler for particular subtree. - * - * Configuration commit handler is invoked for all write transactions - * which modifies subtree + * Register configuration commit handler for particular subtree. Configuration commit handler is invoked for all + * write transactions which modifies subtree * * @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. */ > ObjectRegistration registerConfigurationCommitHandler( P subtree, C commitHandler); -- 2.36.6