reduce public footprint (more than will be useful in long run, but ..…

….); make (non-polymorphic) factory methods static
matsim-vsp · Nov 15, 2023 · 22c2058 · 22c2058
1 parent 485d24c
commit 22c2058
Show file tree

Hide file tree

Showing 15 changed files with 37 additions and 35 deletions.
diff --git a/...im/freight/logistics/example/lsp/multipleChains/ExampleGroceryDeliveryMultipleChains.java b/...im/freight/logistics/example/lsp/multipleChains/ExampleGroceryDeliveryMultipleChains.java
@@ -34,7 +34,7 @@
 
 import static org.matsim.freight.logistics.example.lsp.multipleChains.MultipleChainsUtils.createLSPShipmentsFromCarrierShipments;
 
-public class ExampleGroceryDeliveryMultipleChains {
+final class ExampleGroceryDeliveryMultipleChains {
 
 	private static final Logger log = LogManager.getLogger(ExampleGroceryDeliveryMultipleChains.class);
 	static double HUBCOSTS_FIX = 100;
@@ -78,7 +78,7 @@ public void install() {
 //					strategyManager.addStrategy(new RandomShiftingStrategyFactory().createStrategy(), null, 1);
 //					strategyManager.addStrategy(new ProximityStrategyFactory(scenario.getNetwork()).createStrategy(), null, 1);
 //					strategyManager.setMaxPlansPerAgent(5);
-					strategyManager.setPlanSelectorForRemoval(new WorstPlanForRemovalSelector());
+					strategyManager.setPlanSelectorForRemoval(new LSPWorstPlanForRemovalSelector() );
 					return strategyManager;
 				});
 			}

diff --git a/...atsim/freight/logistics/example/lsp/multipleChains/ExampleMultipleMixedEchelonChains.java b/...atsim/freight/logistics/example/lsp/multipleChains/ExampleMultipleMixedEchelonChains.java
@@ -33,7 +33,7 @@
 
 import java.util.*;
 
-public class ExampleMultipleMixedEchelonChains {
+final class ExampleMultipleMixedEchelonChains {
 
 	private static final Logger log = LogManager.getLogger(ExampleMultipleMixedEchelonChains.class);
 

diff --git a/.../matsim/freight/logistics/example/lsp/multipleChains/ExampleMultipleOneEchelonChains.java b/.../matsim/freight/logistics/example/lsp/multipleChains/ExampleMultipleOneEchelonChains.java
@@ -33,7 +33,7 @@
 import java.util.Collections;
 import java.util.List;
 
-public class ExampleMultipleOneEchelonChains {
+final class ExampleMultipleOneEchelonChains {
 
 	private static final Logger log = LogManager.getLogger(ExampleMultipleOneEchelonChains.class);
 

diff --git a/...eight/logistics/example/lsp/multipleChains/ExampleMultipleOneEchelonChainsReplanning.java b/...eight/logistics/example/lsp/multipleChains/ExampleMultipleOneEchelonChainsReplanning.java
@@ -35,7 +35,7 @@
 import java.util.Collections;
 import java.util.List;
 
-public class ExampleMultipleOneEchelonChainsReplanning {
+final class ExampleMultipleOneEchelonChainsReplanning {
 
 	private static final Logger log = LogManager.getLogger(ExampleMultipleOneEchelonChainsReplanning.class);
 
@@ -96,7 +96,7 @@ public void install() {
 //					strategyManager.addStrategy(new RandomShiftingStrategyFactory().createStrategy(), null, 1);
 //					strategyManager.addStrategy(new ProximityStrategyFactory(scenario.getNetwork()).createStrategy(), null, 1);
 					strategyManager.setMaxPlansPerAgent(5);
-					strategyManager.setPlanSelectorForRemoval(new WorstPlanForRemovalSelector());
+					strategyManager.setPlanSelectorForRemoval(new LSPWorstPlanForRemovalSelector() );
 					return strategyManager;
 				});
 			}

diff --git a/...eight/logistics/example/lsp/multipleChains/ExampleMultipleTwoEchelonChainsReplanning.java b/...eight/logistics/example/lsp/multipleChains/ExampleMultipleTwoEchelonChainsReplanning.java
@@ -37,7 +37,7 @@
 import java.util.Collections;
 import java.util.List;
 
-public class ExampleMultipleTwoEchelonChainsReplanning {
+final class ExampleMultipleTwoEchelonChainsReplanning {
 
 	private static final Logger log = LogManager.getLogger(ExampleMultipleTwoEchelonChainsReplanning.class);
 
@@ -96,9 +96,9 @@ public void install() {
 				bind(LSPStrategyManager.class).toProvider(() -> {
 					LSPStrategyManager strategyManager = new LSPStrategyManagerImpl();
 					strategyManager.addStrategy(new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup())), null, 1);
-					strategyManager.addStrategy(new ProximityStrategyFactory(scenario.getNetwork()).createStrategy(), null, 1);
+					strategyManager.addStrategy( ProximityStrategyFactory.createStrategy( scenario.getNetwork() ), null, 1);
 					strategyManager.setMaxPlansPerAgent(5);
-					strategyManager.setPlanSelectorForRemoval(new WorstPlanForRemovalSelector());
+					strategyManager.setPlanSelectorForRemoval(new LSPWorstPlanForRemovalSelector() );
 					return strategyManager;
 				});
 			}

diff --git a/...leChains/WorstPlanForRemovalSelector.java → ...hains/LSPWorstPlanForRemovalSelector.java b/...leChains/WorstPlanForRemovalSelector.java → ...hains/LSPWorstPlanForRemovalSelector.java
@@ -8,7 +8,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
-public class WorstPlanForRemovalSelector implements PlanSelector<LSPPlan, LSP> {
+class LSPWorstPlanForRemovalSelector implements PlanSelector<LSPPlan, LSP> {
 
 	private static final String UNDEFINED_TYPE = "undefined";
 

diff --git a/...ain/java/org/matsim/freight/logistics/example/lsp/multipleChains/MultipleChainsUtils.java b/...ain/java/org/matsim/freight/logistics/example/lsp/multipleChains/MultipleChainsUtils.java
@@ -14,7 +14,9 @@
 
 import static java.util.stream.Collectors.toMap;
 
-public class MultipleChainsUtils {
+class MultipleChainsUtils {
+	private MultipleChainsUtils(){
+	}
 	public static RandomLogisticChainShipmentAssigner createRandomLogisticChainShipmentAssigner() {
 		return new RandomLogisticChainShipmentAssigner();
 	}

diff --git a/...ava/org/matsim/freight/logistics/example/lsp/multipleChains/ProximityStrategyFactory.java b/...ava/org/matsim/freight/logistics/example/lsp/multipleChains/ProximityStrategyFactory.java
@@ -18,15 +18,11 @@
 import java.util.HashMap;
 import java.util.Map;
 
-class ProximityStrategyFactory {
+final class ProximityStrategyFactory {
 
-	private final Network network;
+	private ProximityStrategyFactory() { } // class contains only static methods; do not instantiate
 
-	ProximityStrategyFactory(Network network) {
-		this.network = network;
-	}
-
-	GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
+	static GenericPlanStrategy<LSPPlan, LSP> createStrategy( Network network ) {
 
 		GenericPlanStrategyImpl<LSPPlan, LSP> strategy = new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup()));
 		GenericPlanStrategyModule<LSPPlan> randomModule = new GenericPlanStrategyModule<>() {

diff --git a/...t/logistics/example/lsp/multipleChains/RandomDistributionAllShipmentsStrategyFactory.java b/...t/logistics/example/lsp/multipleChains/RandomDistributionAllShipmentsStrategyFactory.java
@@ -15,12 +15,13 @@
 import java.util.ArrayList;
 import java.util.List;
 
-class RandomDistributionAllShipmentsStrategyFactory {
+final class RandomDistributionAllShipmentsStrategyFactory {
 
-	RandomDistributionAllShipmentsStrategyFactory() {
-	}
+	private RandomDistributionAllShipmentsStrategyFactory() { } // do not instantiate
 
-	GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
+	static GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
+		// yyyy using factory method instead of constructor is a universally accepted approach.  but should be static:
+		// Please refactor.  Thanks!  kai, nov'23
 
 		GenericPlanStrategyImpl<LSPPlan, LSP> strategy = new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup()));
 		GenericPlanStrategyModule<LSPPlan> randomModule = new GenericPlanStrategyModule<>() {

diff --git a/...rg/matsim/freight/logistics/example/lsp/multipleChains/RandomShiftingStrategyFactory.java b/...rg/matsim/freight/logistics/example/lsp/multipleChains/RandomShiftingStrategyFactory.java
@@ -18,10 +18,11 @@
 
 class RandomShiftingStrategyFactory {
 
-	RandomShiftingStrategyFactory() {
-	}
+	private RandomShiftingStrategyFactory() {} // class contains only static methods; do not instantiate.
 
-	GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
+	static GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
+		// yyyy using factory method instead of constructor is a universally accepted approach.  but should be static.
+		// Please refactor.  Thanks!  kai, nov'23
 
 		GenericPlanStrategyImpl<LSPPlan, LSP> strategy = new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup()));
 		GenericPlanStrategyModule<LSPPlan> randomModule = new GenericPlanStrategyModule<>() {

diff --git a/...a/org/matsim/freight/logistics/example/lsp/multipleChains/RebalancingStrategyFactory.java b/...a/org/matsim/freight/logistics/example/lsp/multipleChains/RebalancingStrategyFactory.java
@@ -19,10 +19,13 @@
 class RebalancingStrategyFactory {
 
 
-	RebalancingStrategyFactory() {
-	}
+	private RebalancingStrategyFactory() { } // class contains only static methods; do not instantiate
+
+	static GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
+		// yyyy using factory method instead of constructor is a universally accepted approach.  but should be static.
+		// Please refactor.  Thanks!  kai, nov'23
+
 
-	GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
 		GenericPlanStrategyImpl<LSPPlan, LSP> strategy = new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup()));
 		GenericPlanStrategyModule<LSPPlan> loadBalancingModule = new GenericPlanStrategyModule<>() {
 

diff --git a/...gistics/example/lsp/multipleChains/RoundRobinDistributionAllShipmentsStrategyFactory.java b/...gistics/example/lsp/multipleChains/RoundRobinDistributionAllShipmentsStrategyFactory.java
@@ -37,8 +37,7 @@
 
 /*package-private*/ class RoundRobinDistributionAllShipmentsStrategyFactory {
 
-	/*package-private*/ RoundRobinDistributionAllShipmentsStrategyFactory() {
-	}
+	private RoundRobinDistributionAllShipmentsStrategyFactory() { } // class contains only static methods; do not instantiate
 
 	/*package-private*/ GenericPlanStrategy<LSPPlan, LSP> createStrategy() {
 		GenericPlanStrategyImpl<LSPPlan, LSP> strategy = new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup()));

diff --git a/...freight/logistics/example/lsp/multipleChains/RoundRobinLogisticChainShipmentAssigner.java b/...freight/logistics/example/lsp/multipleChains/RoundRobinLogisticChainShipmentAssigner.java
@@ -19,7 +19,7 @@
  * Requirements: There must be at least one logisticChain in the plan
  */
 
-public class RoundRobinLogisticChainShipmentAssigner implements ShipmentAssigner {
+class RoundRobinLogisticChainShipmentAssigner implements ShipmentAssigner {
 
 	private LSP lsp;
 
@@ -54,4 +54,4 @@ public void assignToPlan(LSPPlan lspPlan, LSPShipment shipment) {
 		shipmentCountByChain.merge(minChain, 1, Integer::sum);
 	}
 
-}
+}
diff --git a/...org/matsim/freight/logistics/example/lsp/multipleChains/MultipleChainsReplanningTest.java b/...org/matsim/freight/logistics/example/lsp/multipleChains/MultipleChainsReplanningTest.java
@@ -93,7 +93,7 @@ public void install() {
 				});
 				bind(LSPStrategyManager.class).toProvider(() -> {
 					LSPStrategyManager strategyManager = new LSPStrategyManagerImpl();
-					strategyManager.addStrategy(new RandomShiftingStrategyFactory().createStrategy(), null, 1);
+					strategyManager.addStrategy( RandomShiftingStrategyFactory.createStrategy(), null, 1);
 					return strategyManager;
 				});
 			}

diff --git a/...t/java/org/matsim/freight/logistics/example/lsp/multipleChains/WorstPlanSelectorTest.java b/...t/java/org/matsim/freight/logistics/example/lsp/multipleChains/WorstPlanSelectorTest.java
@@ -93,9 +93,9 @@ public void install() {
 				bind(LSPStrategyManager.class).toProvider(() -> {
 					LSPStrategyManager strategyManager = new LSPStrategyManagerImpl();
 					strategyManager.addStrategy(new GenericPlanStrategyImpl<>(new ExpBetaPlanSelector<>(new ScoringConfigGroup())), null, 1);
-					strategyManager.addStrategy(new RandomDistributionAllShipmentsStrategyFactory().createStrategy(), null, 1);
+					strategyManager.addStrategy( RandomDistributionAllShipmentsStrategyFactory.createStrategy(), null, 1);
 					strategyManager.setMaxPlansPerAgent(2);
-					strategyManager.setPlanSelectorForRemoval(new WorstPlanForRemovalSelector());
+					strategyManager.setPlanSelectorForRemoval(new LSPWorstPlanForRemovalSelector() );
 					return strategyManager;
 				});
 			}