org.opentripplanner.transit.api.request.FindRoutesRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of application Show documentation

The newest version!

package org.opentripplanner.transit.api.request;

import org.opentripplanner.transit.api.model.FilterValues;
import org.opentripplanner.transit.model.basic.TransitMode;
import org.opentripplanner.transit.model.network.Route;

/**
 * A request for finding {@link Route}s.
 * 
 * This request is used to retrieve Routes that match the provided filter values.
 * At least one filter value must be provided.
 */
public class FindRoutesRequest {

  private final boolean flexibleOnly;
  private final String longName;
  private final String shortName;
  private final FilterValues shortNames;
  private final FilterValues transitModes;
  private final FilterValues agencyIds;

  protected FindRoutesRequest(
    boolean flexibleOnly,
    String longName,
    String shortName,
    FilterValues shortNames,
    FilterValues transitModes,
    FilterValues agencyIds
  ) {
    this.flexibleOnly = flexibleOnly;
    this.longName = longName;
    this.shortName = shortName;
    this.shortNames = shortNames;
    this.transitModes = transitModes;
    this.agencyIds = agencyIds;
  }

  public static FindRoutesRequestBuilder of() {
    return new FindRoutesRequestBuilder();
  }

  public boolean flexibleOnly() {
    return flexibleOnly;
  }

  public String longName() {
    return longName;
  }

  public String shortName() {
    return shortName;
  }

  public FilterValues shortNames() {
    return shortNames;
  }

  public FilterValues transitModes() {
    return transitModes;
  }

  public FilterValues agencies() {
    return agencyIds;
  }
}