org.transitime.utils

Class MapKey

java.lang.Object

org.transitime.utils.MapKey

Direct Known Subclasses:

DataFetcher.DbDataMapKey, ScheduleDataProcessor.TerminalDeparturesKey, ScheduleDataProcessor.TripStopKey, TravelTimesProcessor.ProcessedDataMapKey

@Immutable
public class MapKey
extends java.lang.Object

This class is for having a key for a map that is made up of two or three objects. Often for such keys a shortcut is taken where one simply appends strings together along with a separator character so one gets a key such as "string1|string2". But that is really clunky. Best to do it right and use this class as the key for a map.

It is probably best to subclass this class for each type of map key so that you can make sure that the proper type of key is used for the map. Otherwise it could be confusing if one has multiple different MapKeys. An example of such a subclass is:

public static class TripStopKey extends MapKey { private TripStopKey(String tripId, String stopId) { super(tripId, stopId); }

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
MapKey(java.lang.Object o1, java.lang.Object o2) For when need a key consisting of two objects.
MapKey(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3) For when need a key consisting of three objects.
MapKey(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4) For when need a key consisting of four objects.

Method Summary

Modifier and Type	Method and Description
static MapKey	create(java.lang.Object o1, java.lang.Object o2) A different way of creating a MapKey by using a static method instead of using new MapKey().
static MapKey	create(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3) A different way of creating a MapKey by using a static method instead of using new MapKey().
static MapKey	create(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4) A different way of creating a MapKey by using a static method instead of using new MapKey().
boolean	equals(java.lang.Object obj) Standard equals() override.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapKey

public MapKey(java.lang.Object o1,
              java.lang.Object o2)

For when need a key consisting of two objects.

Parameters:

o1 - Object to be part of the key

o2 - Object to be part of the key

MapKey

public MapKey(java.lang.Object o1,
              java.lang.Object o2,
              java.lang.Object o3)

For when need a key consisting of three objects.

Parameters:

o1 - Object to be part of the key

o2 - Object to be part of the key

o3 - Object to be part of the key

MapKey

public MapKey(java.lang.Object o1,
              java.lang.Object o2,
              java.lang.Object o3,
              java.lang.Object o4)

For when need a key consisting of four objects.

Parameters:

o1 - Object to be part of the key

o2 - Object to be part of the key

o3 - Object to be part of the key

o4 - Object to be part of the key

Method Detail

create

public static MapKey create(java.lang.Object o1,
                            java.lang.Object o2)

A different way of creating a MapKey by using a static method instead of using new MapKey(). For when key consists of two strings.

Parameters:

o1 - Object to be part of the key

o2 - Object to be part of the key

Returns:

the MapKey for the specified objects

create

public static MapKey create(java.lang.Object o1,
                            java.lang.Object o2,
                            java.lang.Object o3)

A different way of creating a MapKey by using a static method instead of using new MapKey(). For when key consists of three strings.

Parameters:

o1 - Object to be part of the key

o2 - Object to be part of the key

o3 - Object to be part of the key

Returns:

the MapKey for the specified objects

create

public static MapKey create(java.lang.Object o1,
                            java.lang.Object o2,
                            java.lang.Object o3,
                            java.lang.Object o4)

A different way of creating a MapKey by using a static method instead of using new MapKey(). For when key consists of four objects.

Parameters:

o1 - Object to be part of the key

o2 - Object to be part of the key

o3 - Object to be part of the key

o4 - Object to be part of the key

Returns:

the MapKey for the specified strings

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

the cached hash code

equals

public boolean equals(java.lang.Object obj)

Standard equals() override.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object