org.opentripplanner.routing.core

Class StopMatcher

java.lang.Object

org.opentripplanner.routing.core.StopMatcher

All Implemented Interfaces:

Serializable, Cloneable

public class StopMatcher
extends Object
implements Cloneable, Serializable

A StopMatcher is a collection of stops based on IDs and agency IDs. We currently only support full stop IDs (agencyId:stopId). Support for other matching expression (or other types of stop banning) can be easily added later on.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
String	asString() Returns string representation of this matcher
StopMatcher	clone()
static StopMatcher	emptyMatcher() Return an empty matcher (which matches no stops).
boolean	equals(Object another)
int	hashCode()
boolean	isEmpty() Returns whether this matcher is empty
boolean	matches(Stop stop) Function to determine whether this StopMatcher matches a particular stop.
static StopMatcher	parse(String stopList) Build a new StopMatcher from a string representation.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

emptyMatcher

public static StopMatcher emptyMatcher()

Return an empty matcher (which matches no stops).

isEmpty

public boolean isEmpty()

Returns whether this matcher is empty

Returns:

true when this matcher is empty, false otherwise

parse

public static StopMatcher parse(String stopList)

Build a new StopMatcher from a string representation.

Parameters:

stopList - is a comma-separated list of stops, each of the format [agencyId]:[stopId]

Returns:

A StopMatcher

Throws:

IllegalArgumentException - if the string representation is invalid.

matches

public boolean matches(Stop stop)

Function to determine whether this StopMatcher matches a particular stop. When a stop has a parent stop, it is also matched when its parent stop is matched.

Parameters:

stop - is the stop to match using its ID

Returns:

true when the stop is matched

asString

public String asString()

Returns string representation of this matcher

Returns:

string representation of this matcher

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object another)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StopMatcher clone()

Overrides:

clone in class Object