fix: removing hyphens and javadoc message grooming

Signed-off-by: Matt Peterson <[email protected]>

Author: mattp-swirldslabs

server/src/main/java/com/hedera/block/server/BlockStreamService.java

@@ -69,7 +69,7 @@ public Descriptors.FileDescriptor proto() {
      * Returns the service name for the BlockStreamService.  This service name corresponds to the service name in
      * the proto file.
      *
-     * @return the service name
+     * @return the service name corresponding to the service name in the proto file
      */
     @Override
     public String serviceName() {

server/src/main/java/com/hedera/block/server/consumer/LiveStreamObserver.java

@@ -24,8 +24,8 @@
  * the implementation of this interface can receive and process inbound messages with different types from
  * the producer and response messages from the consumer.
  *
- * @param <U> - the type of the block
- * @param <V> - the type of the StreamObserver
+ * @param <U> the type of the block
+ * @param <V> the type of the StreamObserver
  */
 public interface LiveStreamObserver<U, V> extends StreamObserver<V> {
 

server/src/main/java/com/hedera/block/server/consumer/LiveStreamObserverImpl.java

@@ -59,7 +59,7 @@ public LiveStreamObserverImpl(
     /**
      * Pass the block to the observer provided by Helidon
      *
-     * @param block - the block to be passed to the observer
+     * @param block the block to be passed to the observer
      */
     @Override
     public void notify(final BlockStreamServiceGrpcProto.Block block) {
@@ -108,8 +108,7 @@ public void onError(final Throwable t) {
 
     /**
      * The onCompleted() method is triggered by Helidon when the bidirectional stream to the downstream consumer is completed.
-     * Unsubscribe the observer from the mediator.
-     *
+     * This implementation will then unsubscribe the observer from the mediator.
      */
     @Override
     public void onCompleted() {

server/src/main/java/com/hedera/block/server/mediator/LiveStreamMediatorImpl.java

@@ -49,7 +49,7 @@ public LiveStreamMediatorImpl(final BlockPersistenceHandler<BlockStreamServiceGr
     /**
      * Subscribe a new observer to the mediator
      *
-     * @param liveStreamObserver - the observer to be subscribed
+     * @param liveStreamObserver the observer to be subscribed
      */
     @Override
     public void subscribe(final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
@@ -59,7 +59,7 @@ public void subscribe(final LiveStreamObserver<BlockStreamServiceGrpcProto.Block
     /**
      * Unsubscribe an observer from the mediator
      *
-     * @param liveStreamObserver - the observer to be unsubscribed
+     * @param liveStreamObserver the observer to be unsubscribed
      */
     @Override
     public void unsubscribe(final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
@@ -73,7 +73,7 @@ public void unsubscribe(final LiveStreamObserver<BlockStreamServiceGrpcProto.Blo
     /**
      * Check if an observer is subscribed to the mediator
      *
-     * @param observer - the observer to be checked
+     * @param observer the observer to be checked
      * @return true if the observer is subscribed, false otherwise
      */
     @Override
@@ -92,7 +92,7 @@ public void unsubscribeAll() {
     /**
      * Notify all observers of a new block
      *
-     * @param block - the block to be notified to all observers
+     * @param block the block to be notified to all observers
      */
     @Override
     public void notifyAll(final BlockStreamServiceGrpcProto.Block block) {

server/src/main/java/com/hedera/block/server/mediator/StreamMediator.java

@@ -34,21 +34,21 @@ public interface StreamMediator<U, V> {
     /**
      * Subscribes a new LiveStreamObserver to receive blocks from the producer as they arrive
      *
-     * @param observer - the LiveStreamObserver to subscribe
+     * @param observer the LiveStreamObserver to subscribe
      */
     void subscribe(final LiveStreamObserver<U, V> observer);
 
     /**
      * Unsubscribes a LiveStreamObserver from the producer
      *
-     * @param observer - the LiveStreamObserver to unsubscribe
+     * @param observer the LiveStreamObserver to unsubscribe
      */
     void unsubscribe(final LiveStreamObserver<U, V> observer);
 
     /**
      * Checks if the observer is subscribed to the producer
      *
-     * @param observer - the LiveStreamObserver to check
+     * @param observer the LiveStreamObserver to check
      * @return true if the observer is subscribed, false otherwise
      */
     boolean isSubscribed(final LiveStreamObserver<U, V> observer);
@@ -61,7 +61,7 @@ public interface StreamMediator<U, V> {
     /**
      * Passes the newly arrived block to all subscribers
      *
-     * @param block - the block to pass to the subscribers
+     * @param block the block to pass to the subscribers
      */
     void notifyAll(final U block);
 }

server/src/main/java/com/hedera/block/server/persistence/BlockPersistenceHandler.java

@@ -39,7 +39,7 @@ public interface BlockPersistenceHandler<V> {
      * Reads a block.
      *
      * @param id the id of the block to read
-     * @return the block
+     * @return an Optional of the block
      */
     Optional<V> read(final long id);
 

server/src/main/java/com/hedera/block/server/persistence/WriteThroughCacheHandler.java

@@ -64,7 +64,7 @@ public Long persist(final BlockStreamServiceGrpcProto.Block block) {
      *
      * @param startBlockId the start block id
      * @param endBlockId the end block id
-     * @return the blocks
+     * @return a queue of blocks
      */
     @Override
     public Queue<BlockStreamServiceGrpcProto.Block> readRange(final long startBlockId, final long endBlockId) {
@@ -82,10 +82,12 @@ public Queue<BlockStreamServiceGrpcProto.Block> readRange(final long startBlockI
     }
 
     /**
-     * Reads a block from cache first.  If the block is not in cache, read from storage and update the cache.
+     * The read method first checks the cache for the block.
+     * If the block is not in cache, then it reads from storage and
+     * updates the cache.
      *
      * @param id the block id
-     * @return the block
+     * @return an Optional with the block
      */
     @Override
     public Optional<BlockStreamServiceGrpcProto.Block> read(final long id) {

server/src/main/java/com/hedera/block/server/persistence/cache/LRUCache.java

@@ -29,7 +29,7 @@
 @Singleton
 public class LRUCache implements BlockCache<BlockStreamServiceGrpcProto.Block> {
 
-    private final Map<Long, BlockStreamServiceGrpcProto.Block> m;
+    private final Map<Long, BlockStreamServiceGrpcProto.Block> cache;
 
     /**
      * Constructor for the LRUCache class.
@@ -40,7 +40,7 @@ public LRUCache(final long maxEntries) {
         final System.Logger LOGGER = System.getLogger(getClass().getName());
         LOGGER.log(System.Logger.Level.INFO, "Creating LRUCache with maxEntries: " + maxEntries);
 
-        m = Collections.synchronizedMap(new BNLinkedHashMap<>(maxEntries));
+        cache = Collections.synchronizedMap(new BNLinkedHashMap<>(maxEntries));
     }
 
     /**
@@ -52,7 +52,7 @@ public LRUCache(final long maxEntries) {
     @Override
     public Long insert(final BlockStreamServiceGrpcProto.Block block) {
         final long id = block.getId();
-        m.putIfAbsent(id, block);
+        cache.putIfAbsent(id, block);
         return id;
     }
 
@@ -64,7 +64,7 @@ public Long insert(final BlockStreamServiceGrpcProto.Block block) {
      */
     @Override
     public BlockStreamServiceGrpcProto.Block get(final Long id) {
-        return m.get(id);
+        return cache.get(id);
     }
 
     /**
@@ -74,6 +74,6 @@ public BlockStreamServiceGrpcProto.Block get(final Long id) {
      */
     @Override
     public boolean contains(final Long id) {
-        return m.containsKey(id);
+        return cache.containsKey(id);
     }
 }

server/src/main/java/com/hedera/block/server/producer/ProducerBlockStreamObserver.java

@@ -25,7 +25,6 @@
  * gRPC service implementation.  Helidon calls methods on this class as networking events occur
  * with the connection to the upstream producer (e.g. blocks streamed from the Consensus Node to
  * the server).
- *
  */
 public class ProducerBlockStreamObserver implements StreamObserver<BlockStreamServiceGrpcProto.Block> {
 
@@ -40,7 +39,6 @@ public class ProducerBlockStreamObserver implements StreamObserver<BlockStreamSe
      *
      * @param streamMediator the stream mediator
      * @param responseStreamObserver the response stream observer
-     *
      */
     public ProducerBlockStreamObserver(final StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamMediator,
                                        final StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> responseStreamObserver) {
@@ -52,7 +50,7 @@ public ProducerBlockStreamObserver(final StreamMediator<BlockStreamServiceGrpcPr
      * Helidon triggers this method when it receives a new block from the upstream producer.  The method notifies all
      * the mediator subscribers and sends a response back to the upstream producer.
      *
-     * @param block - the block streamed from the upstream producer
+     * @param block the block streamed from the upstream producer
      */
     @Override
     public void onNext(final BlockStreamServiceGrpcProto.Block block) {
@@ -75,7 +73,6 @@ public void onError(final Throwable t) {
     /**
      * Helidon triggers this method when the bidirectional stream to the upstream producer is completed.
      * Unsubscribe all the observers from the mediator.
-     *
      */
     @Override
     public void onCompleted() {