Module OneMTA

Package dev.katsute.onemta.types

Class TransitAlert<RID,R extends TransitRoute<?,?,?>,SID,S extends TransitStop<?,?,?>>

java.lang.Object

dev.katsute.onemta.types.TransitAlert<RID,R,SID,S>

Type Parameters:

RID - route ID format

R - transit route type

SID - stop ID format

S - transit stop type

Direct Known Subclasses:

Bus.Alert, LIRR.Alert, MNR.Alert, Subway.Alert

public abstract class TransitAlert<RID,R extends TransitRoute<?,?,?>,SID,S extends TransitStop<?,?,?>>
extends Object

Represents a transit alert.

Since:

1.0.0

Version:

2.0.0

Author:

Katsute

See Also:

• TransitAlertPeriod

Constructor Summary

Constructors

Constructor	Description
TransitAlert()

Method Summary

Modifier and Type	Method	Description
abstract TransitAlertPeriod[]	getActivePeriods()	Returns when the alert is active.
abstract String	getAlertID()	Returns the alert ID.
abstract String	getAlertType()	Returns the alert type.
abstract Date	getCreatedAt()	Returns when the alert was created.
abstract Long	getCreatedAtEpochMillis()	Returns when the alert was created as milliseconds since epoch.
abstract String	getDescription()	Returns the alert description.
abstract String	getHeader()	Returns the alert header.
abstract RID[]	getRouteIDs()	Returns which route IDs are affected.
abstract R[]	getRoutes()	Returns which routes are affected.
abstract SID[]	getStopIDs()	Returns which stop IDs are affected.
abstract S[]	getStops()	Returns which stops are affected.
abstract Date	getUpdatedAt()	Returns when the alert was updated.
abstract Long	getUpdatedAtEpochMillis()	Returns when the alert was updated as milliseconds since epoch.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TransitAlert

public TransitAlert()

Method Details

getAlertID

public abstract String getAlertID()

Returns the alert ID.

Returns:

alert ID

Since:

1.0.0

getActivePeriods

public abstract TransitAlertPeriod[] getActivePeriods()

Returns when the alert is active.

Returns:

alert period

Since:

1.0.0

See Also:

• TransitAlertPeriod

getRouteIDs

public abstract RID[] getRouteIDs()

Returns which route IDs are affected.

Returns:

affected route IDs

Since:

1.0.0

See Also:

• getRoutes()

getRoutes

public abstract R[] getRoutes()

Returns which routes are affected.

Returns:

affected routes

Since:

1.0.0

See Also:

• getRouteIDs()

getStopIDs

public abstract SID[] getStopIDs()

Returns which stop IDs are affected.

Returns:

affected stop IDs

Since:

1.0.0

See Also:

• getStops()

getStops

public abstract S[] getStops()

Returns which stops are affected.

Returns:

affected stop IDs

getHeader

public abstract String getHeader()

Returns the alert header.

Returns:

alert header

Since:

1.0.0

getDescription

public abstract String getDescription()

Returns the alert description.

Returns:

alert description

Since:

1.0.0

getCreatedAt

public abstract Date getCreatedAt()

Returns when the alert was created.

Returns:

created at

Since:

2.0.0

See Also:

• Date
• getCreatedAtEpochMillis()

getCreatedAtEpochMillis

public abstract Long getCreatedAtEpochMillis()

Returns when the alert was created as milliseconds since epoch.

Returns:

created at

Since:

2.0.0

See Also:

• getCreatedAtEpochMillis()

getUpdatedAt

public abstract Date getUpdatedAt()

Returns when the alert was updated.

Returns:

created at

Since:

2.0.0

See Also:

• Date
• getUpdatedAtEpochMillis()

getUpdatedAtEpochMillis

public abstract Long getUpdatedAtEpochMillis()

Returns when the alert was updated as milliseconds since epoch.

Returns:

created at

Since:

2.0.0

See Also:

• getUpdatedAtEpochMillis()

getAlertType

public abstract String getAlertType()

Returns the alert type.

Returns:

alert type

Since:

1.0.0