org.opentripplanner.model.calendar.ServiceCalendarDate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.5.0

/* This file is based on code copied from project OneBusAway, see the LICENSE file for further information. */
package org.opentripplanner.model.calendar;

import org.opentripplanner.model.FeedScopedId;

import java.io.Serializable;
import java.util.Objects;

/**
 * This class explicitly activate or disable a service by date. It can be used in two ways.
 * 
 *     in conjunction with {@link ServiceCalendar} to define exceptions to the default service
 *     patterns defined.
 *     
Omit {@link ServiceCalendar} and use this class to specify each date of service.
 * 
 *
 * This class is immutable.
 */
public final class ServiceCalendarDate implements Serializable, Comparable {

    private static final long serialVersionUID = 1L;

    /**
     * Service has been added for the specified date.
     */
    public static final int EXCEPTION_TYPE_ADD = 1;

    /**
     * Service has been removed for the specified date.
     */
    public static final int EXCEPTION_TYPE_REMOVE = 2;

    private final FeedScopedId serviceId;

    private final ServiceDate date;

    private final int exceptionType;

    public ServiceCalendarDate(FeedScopedId serviceId, ServiceDate date, int exceptionType) {
        this.serviceId = serviceId;
        this.date = date;
        this.exceptionType =  exceptionType;
    }

    public FeedScopedId getServiceId() {
        return serviceId;
    }

    public ServiceDate getDate() {
        return date;
    }

    public int getExceptionType() {
        return exceptionType;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;
        ServiceCalendarDate that = (ServiceCalendarDate) o;
        return Objects.equals(serviceId, that.serviceId) && Objects.equals(date, that.date);
    }

    @Override
    public int hashCode() {
        return Objects.hash(serviceId, date);
    }

    @Override
    public String toString() {
        return "";
    }

    /**
     * Default sort order is to sort on {@code serviceId} first and then on {@code date}.
     */
    @Override
    public int compareTo(ServiceCalendarDate other) {
        int c = serviceId.compareTo(other.serviceId);
        if(c == 0) {
            c = date.compareTo(other.date);
        }
        return c;
    }
}