org.opentripplanner.routing.core

Class TraverseModeSet

java.lang.Object

org.opentripplanner.routing.core.TraverseModeSet

All Implemented Interfaces:

Serializable, Cloneable

public class TraverseModeSet
extends Object
implements Cloneable, Serializable

A set of traverse modes -- typically, one non-transit mode (walking, biking, car) and zero or more transit modes (bus, tram, etc). This class allows efficiently adding or removing modes from a set.

Author:

novalis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TraverseModeSet(Collection<TraverseMode> modeList)
TraverseModeSet(String modelist)
TraverseModeSet(TraverseMode... modes)

Method Summary

Modifier and Type	Method and Description
static TraverseModeSet	allModes() Returns a mode set containing all modes.
void	clear() Clear the mode set so that no modes are included.
TraverseModeSet	clone()
boolean	contains(TraverseMode mode)
boolean	equals(Object other)
boolean	get(int modeMask)
boolean	getAirplane()
String	getAsStr() get this traverse mode as a string that can be fed back into the constructor
boolean	getBicycle()
boolean	getBus()
boolean	getCableCar()
boolean	getCar()
boolean	getFerry()
boolean	getFunicular()
boolean	getGondola()
int	getMask()
List<TraverseMode>	getModes()
TraverseModeSet	getNonTransitSet() Returns a TraverseModeSet containing only the non-transit modes set.
boolean	getRail()
boolean	getSubway()
boolean	getTram()
boolean	getWalk()
int	hashCode()
boolean	isTransit() Returns true if the trip may use some transit mode
boolean	isValid()
void	setAirplane(boolean airplane)
void	setBicycle(boolean bicycle)
void	setBus(boolean bus)
void	setCableCar(boolean cableCar)
void	setCar(boolean car)
void	setFerry(boolean ferry)
void	setFunicular(boolean funicular)
void	setGondola(boolean gondola)
void	setMode(TraverseMode mode, boolean value)
void	setRail(boolean rail)
void	setSubway(boolean subway)
void	setTram(boolean tram)
void	setTransit(boolean transit)
void	setWalk(boolean walk)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TraverseModeSet

public TraverseModeSet(String modelist)

TraverseModeSet

public TraverseModeSet(TraverseMode... modes)

TraverseModeSet

public TraverseModeSet(Collection<TraverseMode> modeList)

Method Detail

allModes

public static TraverseModeSet allModes()

Returns a mode set containing all modes.

Returns:

getMask

public int getMask()

setMode

public void setMode(TraverseMode mode,
                    boolean value)

getBicycle

public boolean getBicycle()

getWalk

public boolean getWalk()

getCar

public boolean getCar()

getTram

public boolean getTram()

getBus

public boolean getBus()

getGondola

public boolean getGondola()

getFerry

public boolean getFerry()

getCableCar

public boolean getCableCar()

getFunicular

public boolean getFunicular()

getRail

public boolean getRail()

getSubway

public boolean getSubway()

getAirplane

public boolean getAirplane()

setBicycle

public void setBicycle(boolean bicycle)

setWalk

public void setWalk(boolean walk)

setCar

public void setCar(boolean car)

setTram

public void setTram(boolean tram)

setBus

public void setBus(boolean bus)

setFerry

public void setFerry(boolean ferry)

setCableCar

public void setCableCar(boolean cableCar)

setGondola

public void setGondola(boolean gondola)

setFunicular

public void setFunicular(boolean funicular)

setSubway

public void setSubway(boolean subway)

setRail

public void setRail(boolean rail)

setAirplane

public void setAirplane(boolean airplane)

isTransit

public boolean isTransit()

Returns true if the trip may use some transit mode

setTransit

public void setTransit(boolean transit)

getNonTransitSet

public TraverseModeSet getNonTransitSet()

Returns a TraverseModeSet containing only the non-transit modes set.

getModes

public List<TraverseMode> getModes()

isValid

public boolean isValid()

contains

public boolean contains(TraverseMode mode)

get

public boolean get(int modeMask)

toString

public String toString()

Overrides:

toString in class Object

getAsStr

public String getAsStr()

get this traverse mode as a string that can be fed back into the constructor

clone

public TraverseModeSet clone()

Overrides:

clone in class Object

clear

public void clear()

Clear the mode set so that no modes are included.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object