de.schildbach.pte.dto.NearbyLocationsResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of public-transport-enabler Show documentation

enabler

There is a newer version: 2

Show newest version

/*
 * Copyright 2010-2015 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package de.schildbach.pte.dto;

import static com.google.common.base.Preconditions.checkNotNull;

import java.io.Serializable;
import java.util.List;

import javax.annotation.Nullable;

import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;

/**
 * @author Andreas Schildbach
 */
@SuppressWarnings("serial")
public final class NearbyLocationsResult implements Serializable {
    public enum Status {
        OK, INVALID_ID, SERVICE_DOWN
    }

    public final @Nullable ResultHeader header;
    public final Status status;
    public final List locations;

    public NearbyLocationsResult(final ResultHeader header, final List locations) {
        this.header = header;
        this.status = Status.OK;
        this.locations = checkNotNull(locations);
    }

    public NearbyLocationsResult(final ResultHeader header, final Status status) {
        this.header = header;
        this.status = checkNotNull(status);
        this.locations = null;
    }

    @Override
    public String toString() {
        final ToStringHelper helper = MoreObjects.toStringHelper(this).addValue(status);
        if (locations != null)
            helper.add("size", locations.size()).add("locations", locations);
        return helper.toString();
    }

    public String toShortString() {
        if (status == Status.OK)
            return locations.size() + " locations";
        else
            return status.toString();
    }
}