Merge pull request #6147 from Skanetrafiken/nullability-leg-and-trip

Add @nullable annotations to Trip and Leg

application/src/ext/java/org/opentripplanner/ext/fares/impl/CombinedInterlinedTransitLeg.java

@@ -5,6 +5,7 @@
 import java.time.ZonedDateTime;
 import java.util.List;
 import java.util.Set;
+import javax.annotation.Nullable;
 import org.locationtech.jts.geom.LineString;
 import org.opentripplanner.framework.collection.ListUtils;
 import org.opentripplanner.model.fare.FareProductUse;
@@ -94,6 +95,7 @@ public List<StopArrival> getIntermediateStops() {
   }
 
   @Override
+  @Nullable
   public LineString getLegGeometry() {
     return null;
   }

application/src/ext/java/org/opentripplanner/ext/flex/FlexibleTransitLeg.java

@@ -6,6 +6,7 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import javax.annotation.Nullable;
 import org.locationtech.jts.geom.LineString;
 import org.opentripplanner.ext.flex.edgetype.FlexTripEdge;
 import org.opentripplanner.framework.i18n.I18NString;
@@ -65,6 +66,7 @@ public Agency getAgency() {
   }
 
   @Override
+  @Nullable
   public Operator getOperator() {
     return getTrip().getOperator();
   }

application/src/main/java/org/opentripplanner/model/plan/Leg.java

@@ -161,6 +161,7 @@ default boolean overlapInTime(Leg other) {
   /**
    * For transit legs, the route agency. For non-transit legs {@code null}.
    */
+  @Nullable
   default Agency getAgency() {
     return null;
   }
@@ -171,13 +172,15 @@ default Agency getAgency() {
    *
    * @see Trip#getOperator()
    */
+  @Nullable
   default Operator getOperator() {
     return null;
   }
 
   /**
    * For transit legs, the route. For non-transit legs, null.
    */
+  @Nullable
   default Route getRoute() {
     return null;
   }
@@ -198,6 +201,7 @@ default TripOnServiceDate getTripOnServiceDate() {
     return null;
   }
 
+  @Nullable
   default Accessibility getTripWheelchairAccessibility() {
     return null;
   }
@@ -245,6 +249,7 @@ default boolean getRealTime() {
     return false;
   }
 
+  @Nullable
   default RealTimeState getRealTimeState() {
     return null;
   }
@@ -261,6 +266,7 @@ default boolean isFlexibleTrip() {
   /**
    * Is this a frequency-based trip with non-strict departure times?
    */
+  @Nullable
   default Boolean getNonExactFrequency() {
     return null;
   }
@@ -270,6 +276,7 @@ default Boolean getNonExactFrequency() {
    * non-strict frequency trips, but could become important for real-time trips, strict frequency
    * trips, and scheduled trips with empirical headways.
    */
+  @Nullable
   default Integer getHeadway() {
     return null;
   }
@@ -293,13 +300,15 @@ default int getAgencyTimeZoneOffset() {
    * using the Hierarchical Vehicle Type (HVT) codes from the European TPEG standard Also see
    * http://groups.google.com/group/gtfs-changes/msg/ed917a69cf8c5bef
    */
+  @Nullable
   default Integer getRouteType() {
     return null;
   }
 
   /**
    * For transit legs, the headsign of the bus or train being used. For non-transit legs, null.
    */
+  @Nullable
   default I18NString getHeadsign() {
     return null;
   }
@@ -312,13 +321,15 @@ default I18NString getHeadsign() {
    * for a given trip may happen at service date March 25th and service time 25:00, which in local
    * time would be Mach 26th 01:00.
    */
+  @Nullable
   default LocalDate getServiceDate() {
     return null;
   }
 
   /**
    * For transit leg, the route's branding URL (if one exists). For non-transit legs, null.
    */
+  @Nullable
   default String getRouteBrandingUrl() {
     return null;
   }
@@ -337,13 +348,15 @@ default String getRouteBrandingUrl() {
    * For transit legs, intermediate stops between the Place where the leg originates and the Place
    * where the leg ends. For non-transit legs, {@code null}.
    */
+  @Nullable
   default List<StopArrival> getIntermediateStops() {
     return null;
   }
 
   /**
    * The leg's geometry.
    */
+  @Nullable
   LineString getLegGeometry();
 
   /**
@@ -352,6 +365,7 @@ default List<StopArrival> getIntermediateStops() {
    * The elevation profile as a comma-separated list of x,y values. x is the distance from the start
    * of the leg, y is the elevation at this distance.
    */
+  @Nullable
   default ElevationProfile getElevationProfile() {
     return null;
   }
@@ -364,56 +378,67 @@ default List<WalkStep> getWalkSteps() {
   }
 
   default Set<StreetNote> getStreetNotes() {
-    return null;
+    return Set.of();
   }
 
   default Set<TransitAlert> getTransitAlerts() {
     return Set.of();
   }
 
+  @Nullable
   default PickDrop getBoardRule() {
     return null;
   }
 
+  @Nullable
   default PickDrop getAlightRule() {
     return null;
   }
 
+  @Nullable
   default BookingInfo getDropOffBookingInfo() {
     return null;
   }
 
+  @Nullable
   default BookingInfo getPickupBookingInfo() {
     return null;
   }
 
+  @Nullable
   default ConstrainedTransfer getTransferFromPrevLeg() {
     return null;
   }
 
+  @Nullable
   default ConstrainedTransfer getTransferToNextLeg() {
     return null;
   }
 
+  @Nullable
   default Integer getBoardStopPosInPattern() {
     return null;
   }
 
+  @Nullable
   default Integer getAlightStopPosInPattern() {
     return null;
   }
 
+  @Nullable
   default Integer getBoardingGtfsStopSequence() {
     return null;
   }
 
+  @Nullable
   default Integer getAlightGtfsStopSequence() {
     return null;
   }
 
   /**
    * Is this leg walking with a bike?
    */
+  @Nullable
   default Boolean getWalkingBike() {
     return null;
   }
@@ -435,10 +460,12 @@ default Float accessibilityScore() {
     return null;
   }
 
+  @Nullable
   default Boolean getRentedVehicle() {
     return null;
   }
 
+  @Nullable
   default String getVehicleRentalNetwork() {
     return null;
   }
@@ -453,6 +480,7 @@ default String getVehicleRentalNetwork() {
    */
   int getGeneralizedCost();
 
+  @Nullable
   default LegReference getLegReference() {
     return null;
   }

application/src/main/java/org/opentripplanner/model/plan/ScheduledTransitLeg.java

@@ -96,10 +96,7 @@ protected ScheduledTransitLeg(ScheduledTransitLegBuilder<?> builder) {
     setDistanceMeters(getDistanceFromCoordinates(transitLegCoordinates));
     this.directDistanceMeters =
       getDistanceFromCoordinates(
-        List.of(
-          transitLegCoordinates.get(0),
-          transitLegCoordinates.get(transitLegCoordinates.size() - 1)
-        )
+        List.of(transitLegCoordinates.getFirst(), transitLegCoordinates.getLast())
       );
   }
 
@@ -139,22 +136,23 @@ public Boolean isInterlinedWithPreviousLeg() {
 
   @Override
   public Agency getAgency() {
-    return getTrip().getRoute().getAgency();
+    return trip().getRoute().getAgency();
   }
 
   @Override
+  @Nullable
   public Operator getOperator() {
-    return getTrip().getOperator();
+    return trip().getOperator();
   }
 
   @Override
   public Route getRoute() {
-    return getTrip().getRoute();
+    return trip().getRoute();
   }
 
   @Override
   public Trip getTrip() {
-    return tripTimes.getTrip();
+    return trip();
   }
 
   @Override
@@ -182,7 +180,7 @@ public LegTime end() {
 
   @Override
   public TransitMode getMode() {
-    return getTrip().getMode();
+    return trip().getMode();
   }
 
   @Override
@@ -247,7 +245,7 @@ public double getDirectDistanceMeters() {
 
   @Override
   public Integer getRouteType() {
-    return getTrip().getRoute().getGtfsType();
+    return trip().getRoute().getGtfsType();
   }
 
   @Override
@@ -300,6 +298,7 @@ public Set<TransitAlert> getTransitAlerts() {
   }
 
   @Override
+  @Nullable
   public PickDrop getBoardRule() {
     if (transferFromPrevLeg != null && transferFromPrevLeg.getTransferConstraint().isStaySeated()) {
       return null;
@@ -308,6 +307,7 @@ public PickDrop getBoardRule() {
   }
 
   @Override
+  @Nullable
   public PickDrop getAlightRule() {
     if (transferToNextLeg != null && transferToNextLeg.getTransferConstraint().isStaySeated()) {
       return null;
@@ -434,6 +434,13 @@ public String toString() {
       .toString();
   }
 
+  /**
+   * Non-null getter for trip
+   */
+  private Trip trip() {
+    return tripTimes.getTrip();
+  }
+
   private List<Coordinate> extractTransitLegCoordinates(
     TripPattern tripPattern,
     int boardStopIndexInPattern,

application/src/main/java/org/opentripplanner/model/plan/UnknownTransitPathLeg.java

@@ -4,6 +4,7 @@
 
 import java.time.ZonedDateTime;
 import java.util.List;
+import javax.annotation.Nullable;
 import org.locationtech.jts.geom.LineString;
 import org.opentripplanner.framework.time.DurationUtils;
 import org.opentripplanner.framework.tostring.ToStringBuilder;
@@ -84,6 +85,7 @@ public double getDistanceMeters() {
   }
 
   @Override
+  @Nullable
   public LineString getLegGeometry() {
     return null;
   }

application/src/main/java/org/opentripplanner/netex/mapping/ServiceLinkMapper.java

@@ -3,6 +3,7 @@
 import jakarta.xml.bind.JAXBElement;
 import java.util.Arrays;
 import java.util.List;
+import javax.annotation.Nullable;
 import net.opengis.gml._3.LineStringType;
 import org.locationtech.jts.geom.Coordinate;
 import org.locationtech.jts.geom.CoordinateSequence;
@@ -116,6 +117,7 @@ private LineString[] generateGeometriesFromServiceLinks(
     return geometries;
   }
 
+  @Nullable
   private LineString mapServiceLink(
     ServiceLink serviceLink,
     StopPattern stopPattern,

application/src/main/java/org/opentripplanner/transit/model/network/Route.java

@@ -156,6 +156,9 @@ public Integer getGtfsSortOrder() {
     return gtfsSortOrder;
   }
 
+  /**
+   * Returns the NeTEx submode for the route. Will return UNKNOWN by default.
+   */
   public SubMode getNetexSubmode() {
     return netexSubmode;
   }