fix: added final keyword per code review requests

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

Author: mattp-swirldslabs

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

@@ -52,8 +52,8 @@ public class BlockStreamService implements GrpcService {
      * @param timeoutThresholdMillis the timeout threshold in milliseconds
      * @param streamMediator the stream mediator
      */
-    public BlockStreamService(long timeoutThresholdMillis,
-                              StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamMediator) {
+    public BlockStreamService(final long timeoutThresholdMillis,
+                              final StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamMediator) {
 
         this.timeoutThresholdMillis = timeoutThresholdMillis;
         this.streamMediator = streamMediator;
@@ -85,7 +85,7 @@ public String serviceName() {
      * @param routing the routing for the BlockStreamService
      */
     @Override
-    public void update(Routing routing) {
+    public void update(final Routing routing) {
         routing.bidi(CLIENT_STREAMING_METHOD_NAME, this::streamSink);
         routing.bidi(SERVER_STREAMING_METHOD_NAME, this::streamSource);
     }
@@ -98,7 +98,8 @@ public void update(Routing routing) {
      * @return a custom StreamObserver to handle streaming blocks from the producer to all subscribed consumers
      * via the streamMediator as well as sending responses back to the producer.
      */
-    private StreamObserver<BlockStreamServiceGrpcProto.Block> streamSink(StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> responseStreamObserver) {
+    private StreamObserver<BlockStreamServiceGrpcProto.Block> streamSink(
+            final StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> responseStreamObserver) {
         LOGGER.finer("Executing bidirectional streamSink method");
 
         return new ProducerBlockStreamObserver(streamMediator, responseStreamObserver);
@@ -113,14 +114,16 @@ private StreamObserver<BlockStreamServiceGrpcProto.Block> streamSink(StreamObser
      * @return a custom StreamObserver to handle streaming blocks from the producer to the consumer as well as
      * handling responses from the consumer.
      */
-    private StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> streamSource(StreamObserver<BlockStreamServiceGrpcProto.Block> responseStreamObserver) {
+    private StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> streamSource(final StreamObserver<BlockStreamServiceGrpcProto.Block> responseStreamObserver) {
         LOGGER.finer("Executing bidirectional streamSource method");
 
         // Return a custom StreamObserver to handle streaming blocks from the producer.
-        LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamObserver = new LiveStreamObserverImpl(
+        final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamObserver = new LiveStreamObserverImpl(
                 timeoutThresholdMillis,
                 streamMediator,
                 responseStreamObserver);
+
+        // Subscribe the observer to the mediator
         streamMediator.subscribe(streamObserver);
 
         return streamObserver;

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

@@ -22,10 +22,10 @@ public final class Constants {
     private Constants() {}
 
     // Config Constants
-    public static String BLOCKNODE_STORAGE_ROOT_PATH_KEY = "blocknode.storage.root.path";
+    public static final String BLOCKNODE_STORAGE_ROOT_PATH_KEY = "blocknode.storage.root.path";
 
     // Constants specified in the service definition of the .proto file
-    public static String SERVICE_NAME = "BlockStreamGrpc";
-    public static String CLIENT_STREAMING_METHOD_NAME = "StreamSink";
-    public static String SERVER_STREAMING_METHOD_NAME = "StreamSource";
+    public static final String SERVICE_NAME = "BlockStreamGrpc";
+    public static final String CLIENT_STREAMING_METHOD_NAME = "StreamSink";
+    public static final String SERVER_STREAMING_METHOD_NAME = "StreamSource";
 }

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

@@ -56,18 +56,18 @@ private Server() {}
      *
      * @param args Command line arguments. Not used at present,
      */
-    public static void main(String[] args) {
+    public static void main(final String[] args) {
 
         try {
 
             // Set the global configuration
-            Config config = Config.create();
+            final Config config = Config.create();
             Config.global(config);
 
             // Initialize the block storage, cache, and service
-            BlockStorage<BlockStreamServiceGrpcProto.Block> blockStorage = new FileSystemBlockStorage(BLOCKNODE_STORAGE_ROOT_PATH_KEY, config);
-            BlockCache<BlockStreamServiceGrpcProto.Block> blockCache = new LRUCache(1000);
-            BlockStreamService blockStreamService = new BlockStreamService(1500,
+            final BlockStorage<BlockStreamServiceGrpcProto.Block> blockStorage = new FileSystemBlockStorage(BLOCKNODE_STORAGE_ROOT_PATH_KEY, config);
+            final BlockCache<BlockStreamServiceGrpcProto.Block> blockCache = new LRUCache(1000);
+            final BlockStreamService blockStreamService = new BlockStreamService(1500,
                     new LiveStreamMediatorImpl(new WriteThroughCacheHandler(blockStorage, blockCache)));
 
             // Start the web server

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

@@ -36,5 +36,5 @@ public interface LiveStreamObserver<U, V> extends StreamObserver<V> {
      *
      * @param block - the block to be passed to the observer
      */
-    void notify(U block);
+    void notify(final U block);
 }

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

@@ -47,7 +47,7 @@ public class LiveStreamObserverImpl implements LiveStreamObserver<BlockStreamSer
      * @param responseStreamObserver the response stream observer
      *
      */
-    public LiveStreamObserverImpl(long timeoutThresholdMillis,
+    public LiveStreamObserverImpl(final long timeoutThresholdMillis,
             StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> mediator,
             StreamObserver<BlockStreamServiceGrpcProto.Block> responseStreamObserver) {
 
@@ -65,7 +65,7 @@ public LiveStreamObserverImpl(long timeoutThresholdMillis,
      * @param block - the block to be passed to the observer
      */
     @Override
-    public void notify(BlockStreamServiceGrpcProto.Block block) {
+    public void notify(final BlockStreamServiceGrpcProto.Block block) {
 
         if (System.currentTimeMillis() - this.consumerLivenessMillis > timeoutThresholdMillis) {
             if (mediator.isSubscribed(this)) {
@@ -84,7 +84,7 @@ public void notify(BlockStreamServiceGrpcProto.Block block) {
      * @param blockResponse - the BlockResponse passed to the server via the bidirectional stream to the downstream consumer
      */
     @Override
-    public void onNext(BlockStreamServiceGrpcProto.BlockResponse blockResponse) {
+    public void onNext(final BlockStreamServiceGrpcProto.BlockResponse blockResponse) {
 
         if (System.currentTimeMillis() - this.producerLivenessMillis > timeoutThresholdMillis) {
             if (mediator.isSubscribed(this)) {
@@ -104,7 +104,7 @@ public void onNext(BlockStreamServiceGrpcProto.BlockResponse blockResponse) {
      * @param t the error occurred on the stream
      */
     @Override
-    public void onError(Throwable t) {
+    public void onError(final Throwable t) {
         LOGGER.severe("onError: " + t.getMessage());
         mediator.unsubscribe(this);
     }

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

@@ -47,7 +47,7 @@ public class LiveStreamMediatorImpl implements StreamMediator<BlockStreamService
      * @param blockPersistenceHandler the block persistence handler
      *
      */
-    public LiveStreamMediatorImpl(BlockPersistenceHandler<BlockStreamServiceGrpcProto.Block> blockPersistenceHandler) {
+    public LiveStreamMediatorImpl(final BlockPersistenceHandler<BlockStreamServiceGrpcProto.Block> blockPersistenceHandler) {
         this.blockPersistenceHandler = blockPersistenceHandler;
     }
 
@@ -57,7 +57,7 @@ public LiveStreamMediatorImpl(BlockPersistenceHandler<BlockStreamServiceGrpcProt
      * @param liveStreamObserver - the observer to be subscribed
      */
     @Override
-    public void subscribe(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
+    public void subscribe(final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
         this.subscribers.add(liveStreamObserver);
     }
 
@@ -67,7 +67,7 @@ public void subscribe(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, Bloc
      * @param liveStreamObserver - the observer to be unsubscribed
      */
     @Override
-    public void unsubscribe(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
+    public void unsubscribe(final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
         if (this.subscribers.remove(liveStreamObserver)) {
             LOGGER.finer("Successfully removed observer from subscription list");
         } else {
@@ -82,7 +82,7 @@ public void unsubscribe(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, Bl
      * @return true if the observer is subscribed, false otherwise
      */
     @Override
-    public boolean isSubscribed(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> observer) {
+    public boolean isSubscribed(final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> observer) {
         return this.subscribers.contains(observer);
     }
 
@@ -100,10 +100,10 @@ public void unsubscribeAll() {
      * @param block - the block to be notified to all observers
      */
     @Override
-    public void notifyAll(BlockStreamServiceGrpcProto.Block block) {
+    public void notifyAll(final BlockStreamServiceGrpcProto.Block block) {
 
         // Proxy the block to all live stream subscribers
-        for (LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> subscriber : subscribers) {
+        for (final LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> subscriber : subscribers) {
             subscriber.notify(block);
         }
 

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

@@ -38,22 +38,22 @@ public interface StreamMediator<U, V> {
      *
      * @param observer - the LiveStreamObserver to subscribe
      */
-    void subscribe(LiveStreamObserver<U, V> observer);
+    void subscribe(final LiveStreamObserver<U, V> observer);
 
     /**
      * Unsubscribes a LiveStreamObserver from the producer
      *
      * @param observer - the LiveStreamObserver to unsubscribe
      */
-    void unsubscribe(LiveStreamObserver<U, V> observer);
+    void unsubscribe(final LiveStreamObserver<U, V> observer);
 
     /**
      * Checks if the observer is subscribed to the producer
      *
      * @param observer - the LiveStreamObserver to check
      * @return true if the observer is subscribed, false otherwise
      */
-    boolean isSubscribed(LiveStreamObserver<U, V> observer);
+    boolean isSubscribed(final LiveStreamObserver<U, V> observer);
 
     /**
      * Unsubscribes all LiveStreamObservers from the producer
@@ -65,5 +65,5 @@ public interface StreamMediator<U, V> {
      *
      * @param block - the block to pass to the subscribers
      */
-    void notifyAll(U block);
+    void notifyAll(final U block);
 }

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

@@ -35,15 +35,15 @@ public interface BlockPersistenceHandler<V> {
      * @param block the block to persist
      * @return the id of the block
      */
-    Long persist(V block);
+    Long persist(final V block);
 
     /**
      * Reads a block.
      *
      * @param id the id of the block to read
      * @return the block
      */
-    Optional<V> read(long id);
+    Optional<V> read(final long id);
 
     /**
      * Reads a range of blocks.
@@ -52,5 +52,5 @@ public interface BlockPersistenceHandler<V> {
      * @param endBlockId the id of the last block to read
      * @return a queue of blocks
      */
-    Queue<V> readRange(long startBlockId, long endBlockId);
+    Queue<V> readRange(final long startBlockId, final long endBlockId);
 }

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

@@ -43,8 +43,8 @@ public class WriteThroughCacheHandler implements BlockPersistenceHandler<BlockSt
      * @param blockStorage the block storage
      * @param blockCache the block cache
      */
-    public WriteThroughCacheHandler(BlockStorage<BlockStreamServiceGrpcProto.Block> blockStorage,
-                                    BlockCache<BlockStreamServiceGrpcProto.Block> blockCache) {
+    public WriteThroughCacheHandler(final BlockStorage<BlockStreamServiceGrpcProto.Block> blockStorage,
+                                    final BlockCache<BlockStreamServiceGrpcProto.Block> blockCache) {
         this.blockStorage = blockStorage;
         this.blockCache = blockCache;
     }
@@ -56,7 +56,7 @@ public WriteThroughCacheHandler(BlockStorage<BlockStreamServiceGrpcProto.Block>
      * @return the block id
      */
     @Override
-    public Long persist(BlockStreamServiceGrpcProto.Block block) {
+    public Long persist(final BlockStreamServiceGrpcProto.Block block) {
 
         // Write-Through cache
         blockStorage.write(block);
@@ -71,13 +71,13 @@ public Long persist(BlockStreamServiceGrpcProto.Block block) {
      * @return the blocks
      */
     @Override
-    public Queue<BlockStreamServiceGrpcProto.Block> readRange(long startBlockId, long endBlockId) {
-        Queue<BlockStreamServiceGrpcProto.Block> blocks = new ArrayDeque<>();
+    public Queue<BlockStreamServiceGrpcProto.Block> readRange(final long startBlockId, final long endBlockId) {
+        final Queue<BlockStreamServiceGrpcProto.Block> blocks = new ArrayDeque<>();
 
         long count = startBlockId;
         Optional<BlockStreamServiceGrpcProto.Block> blockOpt = read(count);
         while (count <= endBlockId && blockOpt.isPresent()) {
-            BlockStreamServiceGrpcProto.Block block = blockOpt.get();
+            final BlockStreamServiceGrpcProto.Block block = blockOpt.get();
             blocks.offer(block);
             blockOpt = read(++count);
         }
@@ -92,7 +92,7 @@ public Queue<BlockStreamServiceGrpcProto.Block> readRange(long startBlockId, lon
      * @return the block
      */
     @Override
-    public Optional<BlockStreamServiceGrpcProto.Block> read(long id) {
+    public Optional<BlockStreamServiceGrpcProto.Block> read(final long id) {
 
         if (blockCache.contains(id)) {
             return Optional.of(blockCache.get(id));

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

@@ -37,7 +37,7 @@ public class BNLinkedHashMap<K, V> extends LinkedHashMap<K, V> {
      *
      * @param maxEntries the maximum number of entries in the map
      */
-    BNLinkedHashMap(long maxEntries) {
+    BNLinkedHashMap(final long maxEntries) {
         this.maxEntries = maxEntries;
     }
 
@@ -48,7 +48,7 @@ public class BNLinkedHashMap<K, V> extends LinkedHashMap<K, V> {
      * @return true if the eldest entry should be removed, false otherwise
      */
     @Override
-    protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
+    protected boolean removeEldestEntry(final Map.Entry<K, V> eldest) {
 
         if (size() > maxEntries) {
             return true;

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

@@ -31,18 +31,18 @@ public interface BlockCache<V> {
      * @param block the block to insert
      * @return the id of the block
      */
-    Long insert(V block);
+    Long insert(final V block);
 
     /**
      * Retrieves a block from the cache.
      *
      * @param id the id of the block to retrieve
      * @return the block
      */
-    V get(Long id);
+    V get(final Long id);
 
     /**
      * Checks if the cache contains a block with the given id.
      */
-    boolean contains(Long id);
+    boolean contains(final Long id);
 }

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

@@ -33,15 +33,16 @@
 public class LRUCache implements BlockCache<BlockStreamServiceGrpcProto.Block> {
 
     private final Map<Long, BlockStreamServiceGrpcProto.Block> m;
-    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     /**
      * Constructor for the LRUCache class.
      *
      * @param maxEntries the maximum number of entries in the cache
      */
-    public LRUCache(long maxEntries) {
+    public LRUCache(final long maxEntries) {
+        final Logger LOGGER = Logger.getLogger(getClass().getName());
         LOGGER.finer("Creating LRUCache with maxEntries: " + maxEntries);
+
         m = Collections.synchronizedMap(new BNLinkedHashMap<>(maxEntries));
     }
 
@@ -52,8 +53,8 @@ public LRUCache(long maxEntries) {
      * @return the id of the block
      */
     @Override
-    public Long insert(BlockStreamServiceGrpcProto.Block block) {
-        long id = block.getId();
+    public Long insert(final BlockStreamServiceGrpcProto.Block block) {
+        final long id = block.getId();
         m.putIfAbsent(id, block);
         return id;
     }
@@ -65,7 +66,7 @@ public Long insert(BlockStreamServiceGrpcProto.Block block) {
      * @return the block
      */
     @Override
-    public BlockStreamServiceGrpcProto.Block get(Long id) {
+    public BlockStreamServiceGrpcProto.Block get(final Long id) {
         return m.get(id);
     }
 
@@ -75,7 +76,7 @@ public BlockStreamServiceGrpcProto.Block get(Long id) {
      * @param id the id of the block to query
      */
     @Override
-    public boolean contains(Long id) {
+    public boolean contains(final Long id) {
         return m.containsKey(id);
     }
 }

server/src/main/java/com/hedera/block/server/persistence/storage/BlockStorage.java

@@ -33,13 +33,13 @@ public interface BlockStorage<V> {
      * @param block the block to write
      * @return the id of the block
      */
-    Optional<Long> write(V block);
+    Optional<Long> write(final V block);
 
     /**
      * Reads a block from storage.
      *
      * @param blockId the id of the block to read
      * @return the block
      */
-    Optional<V> read(Long blockId);
+    Optional<V> read(final Long blockId);
 }