refactor: Rename TransferParameters to TransferParametersForMode and update references

Author: t2gran

application/src/main/java/org/opentripplanner/graph_builder/module/transfer/DirectTransferGenerator.java

@@ -15,12 +15,12 @@
 import org.opentripplanner.graph_builder.issue.api.DataImportIssueStore;
 import org.opentripplanner.graph_builder.issues.StopNotLinkedForTransfers;
 import org.opentripplanner.graph_builder.model.GraphBuilderModule;
-import org.opentripplanner.graph_builder.module.TransferParameters;
 import org.opentripplanner.graph_builder.module.nearbystops.NearbyStopFinder;
 import org.opentripplanner.graph_builder.module.nearbystops.SiteRepositoryResolver;
 import org.opentripplanner.graph_builder.module.nearbystops.StopResolver;
 import org.opentripplanner.graph_builder.module.nearbystops.StraightLineNearbyStopFinder;
 import org.opentripplanner.graph_builder.module.nearbystops.StreetNearbyStopFinder;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.graph_builder.module.transfer.filter.PatternConsideringNearbyStopFinder;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.graphfinder.NearbyStop;
@@ -53,7 +53,7 @@ public class DirectTransferGenerator implements GraphBuilderModule {
   private final Duration defaultMaxTransferDuration;
 
   private final List<RouteRequest> transferRequests;
-  private final Map<StreetMode, TransferParameters> transferParametersForMode;
+  private final Map<StreetMode, TransferParametersForMode> transferParametersForMode;
   private final Graph graph;
   private final TimetableRepository timetableRepository;
   private final TransferRepository transferRepository;
@@ -86,7 +86,7 @@ public DirectTransferGenerator(
     DataImportIssueStore issueStore,
     Duration defaultMaxTransferDuration,
     List<RouteRequest> transferRequests,
-    Map<StreetMode, TransferParameters> transferParametersForMode
+    Map<StreetMode, TransferParametersForMode> transferParametersForMode
   ) {
     this.graph = graph;
     this.timetableRepository = timetableRepository;
@@ -311,7 +311,7 @@ private TransferConfiguration parseTransferParameters(NearbyStopFinder nearbySto
 
     for (RouteRequest transferProfile : transferRequests) {
       StreetMode mode = transferProfile.journey().transfer().mode();
-      TransferParameters transferParameters = transferParametersForMode.get(mode);
+      var transferParameters = transferParametersForMode.get(mode);
       if (transferParameters != null) {
         // WALK mode transfers can not be disabled. For example, flex transfers need them.
         if (transferParameters.disableDefaultTransfers() && mode == StreetMode.WALK) {

application/src/main/java/org/opentripplanner/graph_builder/module/transfer/api/TransferParametersForMode.java

@@ -1,4 +1,4 @@
-package org.opentripplanner.graph_builder.module;
+package org.opentripplanner.graph_builder.module.transfer.api;
 
 import java.time.Duration;
 import javax.annotation.Nullable;
@@ -7,7 +7,7 @@
 /**
  * Mode-specific parameters for transfers.
  */
-public record TransferParameters(
+public record TransferParametersForMode(
   @Nullable Duration maxTransferDuration,
   @Nullable Duration carsAllowedStopMaxTransferDuration,
   @Nullable Duration bikesAllowedStopMaxTransferDuration,
@@ -18,7 +18,7 @@ public record TransferParameters(
   public static final Duration DEFAULT_BIKES_ALLOWED_STOP_MAX_TRANSFER_DURATION = null;
   public static final boolean DEFAULT_DISABLE_DEFAULT_TRANSFERS = false;
 
-  TransferParameters(Builder builder) {
+  TransferParametersForMode(Builder builder) {
     this(
       builder.maxTransferDuration,
       builder.carsAllowedStopMaxTransferDuration,
@@ -73,8 +73,8 @@ public Builder withDisableDefaultTransfers(boolean disableDefaultTransfers) {
       return this;
     }
 
-    public TransferParameters build() {
-      return new TransferParameters(this);
+    public TransferParametersForMode build() {
+      return new TransferParametersForMode(this);
     }
   }
 }

application/src/main/java/org/opentripplanner/standalone/config/BuildConfig.java

@@ -31,11 +31,11 @@
 import org.opentripplanner.ext.empiricaldelay.config.EmpiricalDelayConfig;
 import org.opentripplanner.ext.empiricaldelay.parameters.EmpiricalDelayParameters;
 import org.opentripplanner.ext.fares.FaresConfiguration;
-import org.opentripplanner.graph_builder.module.TransferParameters;
 import org.opentripplanner.graph_builder.module.ned.parameter.DemExtractParameters;
 import org.opentripplanner.graph_builder.module.ned.parameter.DemExtractParametersList;
 import org.opentripplanner.graph_builder.module.osm.parameters.OsmExtractParameters;
 import org.opentripplanner.graph_builder.module.osm.parameters.OsmExtractParametersList;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.graph_builder.services.osm.EdgeNamer;
 import org.opentripplanner.gtfs.config.GtfsDefaultParameters;
 import org.opentripplanner.netex.config.NetexFeedParameters;
@@ -159,7 +159,7 @@ public class BuildConfig implements OtpDataStoreConfig {
   public final IslandPruningConfig islandPruning;
 
   public final Duration maxTransferDuration;
-  public final Map<StreetMode, TransferParameters> transferParametersForMode;
+  public final Map<StreetMode, TransferParametersForMode> transferParametersForMode;
   public final NetexFeedParameters netexDefaults;
   public final GtfsDefaultParameters gtfsDefaults;
 

application/src/main/java/org/opentripplanner/standalone/config/buildconfig/TransferConfig.java

@@ -4,13 +4,16 @@
 
 import java.util.EnumMap;
 import java.util.Map;
-import org.opentripplanner.graph_builder.module.TransferParameters;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
 import org.opentripplanner.street.model.StreetMode;
 
 public class TransferConfig {
 
-  public static Map<StreetMode, TransferParameters> map(NodeAdapter root, String parameterName) {
+  public static Map<StreetMode, TransferParametersForMode> map(
+    NodeAdapter root,
+    String parameterName
+  ) {
     return root
       .of(parameterName)
       .since(V2_7)

application/src/main/java/org/opentripplanner/standalone/config/buildconfig/TransferParametersMapper.java

@@ -3,19 +3,19 @@
 import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_7;
 import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_9;
 
-import org.opentripplanner.graph_builder.module.TransferParameters;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
 
 public class TransferParametersMapper {
 
-  public static TransferParameters map(NodeAdapter c) {
-    TransferParameters.Builder builder = new TransferParameters.Builder();
+  public static TransferParametersForMode map(NodeAdapter c) {
+    TransferParametersForMode.Builder builder = new TransferParametersForMode.Builder();
     builder.withMaxTransferDuration(
       c
         .of("maxTransferDuration")
         .summary("This overwrites the default `maxTransferDuration` for the given mode.")
         .since(V2_7)
-        .asDuration(TransferParameters.DEFAULT_MAX_TRANSFER_DURATION)
+        .asDuration(TransferParametersForMode.DEFAULT_MAX_TRANSFER_DURATION)
     );
     builder.withCarsAllowedStopMaxTransferDuration(
       c
@@ -44,7 +44,7 @@ The default transfers are calculated based on a configurable range (configurable
           """
         )
         .since(V2_7)
-        .asDuration(TransferParameters.DEFAULT_CARS_ALLOWED_STOP_MAX_TRANSFER_DURATION)
+        .asDuration(TransferParametersForMode.DEFAULT_CARS_ALLOWED_STOP_MAX_TRANSFER_DURATION)
     );
     builder.withBikesAllowedStopMaxTransferDuration(
       c
@@ -68,7 +68,7 @@ The default transfers are calculated based on a configurable range (configurable
           """
         )
         .since(V2_9)
-        .asDuration(TransferParameters.DEFAULT_BIKES_ALLOWED_STOP_MAX_TRANSFER_DURATION)
+        .asDuration(TransferParametersForMode.DEFAULT_BIKES_ALLOWED_STOP_MAX_TRANSFER_DURATION)
     );
     builder.withDisableDefaultTransfers(
       c
@@ -85,7 +85,7 @@ The default transfers are calculated based on a configurable range (configurable
           """
         )
         .since(V2_7)
-        .asBoolean(TransferParameters.DEFAULT_DISABLE_DEFAULT_TRANSFERS)
+        .asBoolean(TransferParametersForMode.DEFAULT_DISABLE_DEFAULT_TRANSFERS)
     );
     return builder.build();
   }

application/src/test/java/org/opentripplanner/graph_builder/module/transfer/DirectTransferGeneratorCarTest.java

@@ -6,7 +6,7 @@
 import java.time.Duration;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner.framework.application.OTPFeature;
-import org.opentripplanner.graph_builder.module.TransferParameters;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.routing.algorithm.GraphRoutingTest;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.api.request.request.StreetRequest;
@@ -25,7 +25,7 @@ class DirectTransferGeneratorCarTest extends GraphRoutingTest {
   @Test
   public void testRequestWithCarsAllowedPatterns() {
     OTPFeature.ConsiderPatternsForDirectTransfers.testOff(() -> {
-      var transferParameters = new TransferParameters.Builder()
+      var transferParameters = new TransferParametersForMode.Builder()
         .withCarsAllowedStopMaxTransferDuration(Duration.ofMinutes(60))
         .withDisableDefaultTransfers(true)
         .build();
@@ -51,7 +51,7 @@ public void testRequestWithCarsAllowedPatterns() {
 
   @Test
   public void testRequestWithCarsAllowedPatternsWithDurationLimit() {
-    var transferParameters = new TransferParameters.Builder()
+    var transferParameters = new TransferParametersForMode.Builder()
       .withCarsAllowedStopMaxTransferDuration(Duration.ofSeconds(10))
       .withDisableDefaultTransfers(true)
       .build();
@@ -71,7 +71,7 @@ public void testRequestWithCarsAllowedPatternsWithDurationLimit() {
 
   @Test
   public void testMultipleRequestsWithPatternsAndWithCarsAllowedPatterns() {
-    var transferParameters = new TransferParameters.Builder()
+    var transferParameters = new TransferParametersForMode.Builder()
       .withCarsAllowedStopMaxTransferDuration(Duration.ofMinutes(60))
       .withDisableDefaultTransfers(true)
       .build();
@@ -109,7 +109,7 @@ public void testMultipleRequestsWithPatternsAndWithCarsAllowedPatterns() {
 
   @Test
   public void testBikeRequestWithPatternsAndWithCarsAllowedPatterns() {
-    var transferParameters = new TransferParameters.Builder()
+    var transferParameters = new TransferParametersForMode.Builder()
       .withCarsAllowedStopMaxTransferDuration(Duration.ofMinutes(120))
       .build();
 
@@ -148,11 +148,11 @@ public void testBikeRequestWithPatternsAndWithCarsAllowedPatternsWithoutCarInTra
 
   @Test
   public void testDisableDefaultTransfersForMode() {
-    var transferParametersBuilderBike = new TransferParameters.Builder()
+    var transferParametersBuilderBike = new TransferParametersForMode.Builder()
       .withDisableDefaultTransfers(true)
       .build();
 
-    var transferParametersBuilderCar = new TransferParameters.Builder()
+    var transferParametersBuilderCar = new TransferParametersForMode.Builder()
       .withDisableDefaultTransfers(true)
       .build();
 
@@ -183,10 +183,10 @@ public void testDisableDefaultTransfersForMode() {
 
   @Test
   public void testMaxTransferDurationForMode() {
-    var transferParametersBuilderWalk = new TransferParameters.Builder()
+    var transferParametersBuilderWalk = new TransferParametersForMode.Builder()
       .withMaxTransferDuration(Duration.ofSeconds(100))
       .build();
-    var transferParametersBuilderBike = new TransferParameters.Builder()
+    var transferParametersBuilderBike = new TransferParametersForMode.Builder()
       .withMaxTransferDuration(Duration.ofSeconds(21))
       .build();
 

application/src/test/java/org/opentripplanner/graph_builder/module/transfer/DirectTransferGeneratorTest.java

@@ -6,7 +6,7 @@
 import java.time.Duration;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner.framework.application.OTPFeature;
-import org.opentripplanner.graph_builder.module.TransferParameters;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.api.request.request.StreetRequest;
 import org.opentripplanner.street.model.StreetMode;
@@ -24,12 +24,8 @@ class DirectTransferGeneratorTest {
   private static final RouteRequest REQUEST_WITH_BIKE_TRANSFER = RouteRequest.of()
     .withJourney(jb -> jb.withTransfer(new StreetRequest(StreetMode.BIKE)))
     .buildDefault();
-  private static final TransferParameters TX_BIKES_ALLOWED_1_h = new TransferParameters(
-    null,
-    null,
-    Duration.parse("PT1H"),
-    true
-  );
+  private static final TransferParametersForMode TX_BIKES_ALLOWED_1_h =
+    new TransferParametersForMode(null, null, Duration.parse("PT1H"), true);
 
   @Test
   public void testStraightLineTransfersWithNoPatterns() {

application/src/test/java/org/opentripplanner/graph_builder/module/transfer/DirectTransferGeneratorTestData.java

@@ -7,7 +7,7 @@
 import java.util.List;
 import java.util.Map;
 import org.opentripplanner.graph_builder.issue.api.DataImportIssueStore;
-import org.opentripplanner.graph_builder.module.TransferParameters;
+import org.opentripplanner.graph_builder.module.transfer.api.TransferParametersForMode;
 import org.opentripplanner.routing.algorithm.GraphRoutingTest;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.street.model.StreetMode;
@@ -38,7 +38,8 @@ class DirectTransferGeneratorTestData extends GraphRoutingTest {
   private boolean includeCarFerryTrips = false;
   private Duration maxTransferDuration = MAX_TRANSFER_DURATION;
   private final List<RouteRequest> transferRequests = new ArrayList<>();
-  private final Map<StreetMode, TransferParameters> transferParametersForMode = new HashMap<>();
+  private final Map<StreetMode, TransferParametersForMode> transferParametersForMode =
+    new HashMap<>();
 
   public DirectTransferGeneratorTestData withPatterns() {
     this.addPatterns = true;
@@ -77,7 +78,7 @@ public DirectTransferGeneratorTestData withTransferRequests(RouteRequest... requ
 
   public DirectTransferGeneratorTestData addTransferParameters(
     StreetMode mode,
-    TransferParameters value
+    TransferParametersForMode value
   ) {
     this.transferParametersForMode.put(mode, value);
     return this;