Time.java

package com.nyubustracker.models;

import android.content.res.Resources;
import android.support.annotation.NonNull;

import com.nyubustracker.R;
import com.nyubustracker.helpers.BusManager;

import java.util.Calendar;
import java.util.Locale;
import java.util.TimeZone;

public class Time implements Comparable<Time> {
    private final TimeOfWeek timeOfWeek;  // Either Weekday, Friday, Weekend.
    private int hour;           // In 24 hour (military) format.
    private int min;
    private boolean AM;         // Used for parsing the input string ("8:04 PM") => 20:04, AM = true
    private String route;       // What route this time corresponds to.
    public Time(String time, TimeOfWeek mTimeOfWeek, String mRoute) {           // Input a string like "8:04 PM".
        timeOfWeek = mTimeOfWeek;
        route = mRoute;
        AM = time.toLowerCase(Locale.ROOT).contains("am");       // Automatically accounts for AM/PM with military time.
        String amOrPm = AM ? "am" : "pm";
        try {
            hour = Integer.parseInt(time.substring(0, time.indexOf(":")).trim());
            min = Integer.parseInt(time.substring(time.indexOf(":") + 1, time.toLowerCase().indexOf(amOrPm)).trim());
        } catch (Exception e) {
            hour = 0;
            min = 0;
            AM = true;
        }
        if (AM && hour == 12) {      // It's 12:xx AM
            hour = 0;
        }
        if (!AM && hour != 12) {     // Its x:xx PM, but not 12:xx PM.
            hour += 12;
        }
    }

    // Create a new Time given a military hour and minute.
    public Time(int mHour, int mMin) {
        AM = mHour < 12;
        hour = mHour;
        min = mMin;
        timeOfWeek = getCurrentTimeOfWeek();
    }

    public static Time getCurrentTime(Calendar calendar) {
        calendar.setTimeZone(TimeZone.getTimeZone("America/New_York"));
        return new Time(calendar.get(Calendar.HOUR_OF_DAY), calendar.get(Calendar.MINUTE));
    }

    public static Time getCurrentTime() {
        return getCurrentTime(Calendar.getInstance());

    }

    // compare is used to sort the list of times being checked for the "nextBusTime" in MainActivity.
    // Return a negative number if Time1 is before, positive number if time2 is before, and 0 otherwise.
    @Override
    public int compareTo(@NonNull Time time2) {
        // timeOfWeek is an enum. ordinal() returns the rank of the given TimeOfWeek.
        if (this.getTimeOfWeek().ordinal() == time2.getTimeOfWeek().ordinal()) {    // Times at the same time in the week.
            if (this.isStrictlyBefore(time2)) {     // Checks hour and minute. Returns false if they're equal or time2 is before.
                return -1;
            }
            if (time2.isStrictlyBefore(this)) {
                return 1;
            }
            // Same exact time (hour, minute, and timeOfWeek). So, check if we're looking at the current time.
            if (this.getRoute() == null) {
                return -1;
            }
            if (time2.getRoute() == null) {
                return 1;
            }
            // Times are the same, but we aren't comparing the current time.
            return 0;
        }
        return this.getTimeOfWeek().ordinal() - time2.getTimeOfWeek().ordinal();
    }

    private TimeOfWeek getCurrentTimeOfWeek() {
        Calendar rightNow = Calendar.getInstance();
        rightNow.setTimeZone(TimeZone.getTimeZone("America/New_York"));
        String dayOfWeek = rightNow.getDisplayName(Calendar.DAY_OF_WEEK, Calendar.LONG, Locale.getDefault());
        TimeOfWeek timeOfWeek = TimeOfWeek.Weekday;
        if (dayOfWeek.equals("Saturday") || dayOfWeek.equals("Sunday"))
            timeOfWeek = TimeOfWeek.Weekend;
        else if (dayOfWeek.equals("Friday")) timeOfWeek = TimeOfWeek.Friday;
        return timeOfWeek;
    }

    // Returns a String representation of the time of week this Time is in.
    public String getTimeOfWeekAsString() {
        switch (timeOfWeek) {
            case Weekday:
                return "Weekday";
            case Friday:
                return "Friday";
            case Weekend:
                return "Weekend";
        }
        //if (MainActivity.LOCAL_LOGV) Log.e("Time Debugging", "Invalid timeOfWeek");
        return "";      // Should never reach here.
    }

    public String getRoute() {
        return route;
    }

    // Return a nice string saying the difference between this time and the argument.
    public String getTimeAsStringUntil(Time t, Resources resources) {
        Time difference = this.getTimeAsTimeUntil(t);
        //if (MainActivity.LOCAL_LOGV) Log.v("Time Debugging", "this: " + this.toString() + " | that: " + t.toString());
        //if (MainActivity.LOCAL_LOGV) Log.v("Time Debugging", "Difference: " + difference.hour + ":" + difference.min);
        if (difference != null) {
            if (this.getTimeOfWeek() != t.getTimeOfWeek()) {
                BusManager.getBusManager().setIsNotDuringSafeRide(false);
                return resources.getString(R.string.offline);
            }
            if (difference.hour >= 3) {
                BusManager.getBusManager().setIsNotDuringSafeRide(false);
                return resources.getString(R.string.offline);
            }
            if (difference.hour == 0 && difference.min == 0) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return resources.getString(R.string.less_one_minute);
            }
            if (difference.hour == 0 && difference.min == 1) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return resources.getString(R.string.one_minute);
            }
            if (difference.hour == 0 && difference.min > 1) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return difference.min + resources.getString(R.string.minutes);
            }
            if (difference.hour > 1 && difference.min == 0) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return difference.hour + resources.getString(R.string.hours);
            }
            if (difference.hour == 1 && difference.min == 0) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return resources.getString(R.string.hour);
            }
            if (difference.hour > 1 && difference.min == 1) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return difference.hour + resources.getString(R.string.hours_and) + difference.min + resources.getString(R.string.one_minute);
            }
            if (difference.hour > 1 && difference.min > 1) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return difference.hour + resources.getString(R.string.hours_and) + difference.min + resources.getString(R.string.minutes);
            }
            if (difference.hour == 1 && difference.min == 1) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return resources.getString(R.string.hour_and_one_min);
            }
            if (difference.hour == 1 && difference.min > 1) {
                BusManager.getBusManager().setIsNotDuringSafeRide(true);
                return resources.getString(R.string.hour_and) + difference.min + resources.getString(R.string.minutes);
            }
        }
        return "";
    }

    // Return a Time object who represents the difference in time between the two Times.
    public Time getTimeAsTimeUntil(Time t) {
        if (this.compareTo(t) <= 0) {
            //if (MainActivity.LOCAL_LOGV) Log.v("Time Debugging", this + " is strictly before " + t);
            int hourDifference = t.hour - this.hour;
            int minDifference = t.min - this.min;
            if (minDifference < 0) {
                hourDifference--;
                minDifference += 60;
            }
            return new Time(hourDifference, minDifference);
        } else {
            return new Time(99, 99);    // This time is 'infinitely' far away.
        }
    }

    public TimeOfWeek getTimeOfWeek() {
        return timeOfWeek;
    }

    public boolean equals(Object t) {
        if (t instanceof Time) {
            Time time = (Time) t;
            return (time.hour == this.hour && time.min == this.min && time.timeOfWeek == this.timeOfWeek);
        }
        return false;
    }

    public String toString() {
        return getHourInNormalTime() + ":" + getMinInNormalTime() + " " + getAMorPM();
    }

    // Return this Time in 12-hour format.
    private int getHourInNormalTime() {
        if (hour == 0 && AM) return 12;
        if (hour > 0 && AM) return hour;
        if (hour > 12 && !AM) return hour - 12;
        if (hour <= 12 && !AM) return hour;
        return hour;
    }

    public int getHour() {
        return hour;
    }

    public int getMinute() {
        return min;
    }

    public boolean isAM() {
        return AM;
    }

    // Ensure the minute string is 2 digits long.
    private String getMinInNormalTime() {
        if (min < 10) return "0" + min;
        else return Integer.toString(min);
    }

    private String getAMorPM() {
        return AM ? "AM" : "PM";
    }

    // isStrictlyBefore(t) returns false if the times are equal or this is after t.
    private boolean isStrictlyBefore(Time t) {
        //if (MainActivity.LOCAL_LOGV) Log.v("Time Debugging", this.toString() + " is strictly before " + t.toString() + ": " + ((this.hour < t.hour) || (this.hour == t.hour && this.min < t.min)));
        return (this.hour < t.hour) || (this.hour == t.hour && this.min < t.min);
    }

    public enum TimeOfWeek {Weekday, Friday, Weekend}
}