Add method to refresh realtime data

[Katsute]

Prerequisites

• I have checked that no other similar feature request already exists.
• I have checked discussions.
• This feature request makes sense for the project.
• I have checked that this feature does not already exist.
• I am running the latest release version.

Feature

Add a new method .update(inplace?) to stop, route, and vehicle objects; to allow developers to refresh realtime data without having to make new calls.

The inplace parameter should be false by default and return a new object to prevent developers from accidentally changing objects that are in use by other concurrent operations.

Reason

Prevent redundant calls to the base object and to reduce confusion for developers expecting the realtime data to update everytime they make a call.

[Katsute]

Possibly add internal interface method init() to initialize and update objects, rather than seting the value directly on the variable and instantiation.

This could open the door to using protected/package-private initializers.

ex: instead of copying and pasting the static route initialization across all route implementations, use a single initializer RouteSchema#init(Route route) and set the values using route.??? = ???

OneMTA/src/main/java/dev/katsute/onemta/MTASchema_Bus.java

Lines 107 to 114 in efe23fe

	private final String routeID = id;
	private final String routeShortName = row.get(csv.getHeaderIndex("route_short_name"));
	private final String routeLongName = row.get(csv.getHeaderIndex("route_long_name"));
	private final String routeDesc = row.get(csv.getHeaderIndex("route_desc"));
	private final String routeColor = row.get(csv.getHeaderIndex("route_color"));
	private final String routeTextColor = row.get(csv.getHeaderIndex("route_text_color"));

vs

protected final String routeID = id;
  
protected final String routeShortName; 
protected final String routeLongName; 
protected final String routeDesc; 
  
protected final String routeColor; 
protected final String routeTextColor;

protected final void init(Route route){
   route.routeShortName = row.get(csv.getHeaderIndex("route_short_name"));
   ...
}

[Katsute]

Only realtime data should be updated, static data should be final. Any arrays should also be regenerated and reassigned, don't update existing arrays.

[Katsute]

First comment method can't be used, protected variables in abstract is not allowed.

Instead move update method to the alerts and vehicles array method. Have optional param update? to determine if class should regenerated arrays, rather than using existing; again use new array, do not update old one.

[Katsute]

@sinon-bot branch refresh

[ghost]

New branch created refresh@efe23fe

_{This branch was created by @Katsute.}