JSONExtraSummary.java

/*
 * This file is part of Openrouteservice.
 *
 * Openrouteservice is free software; you can redistribute it and/or modify it under the terms of the
 * GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this library;
 * if not, see <https://www.gnu.org/licenses/>.
 */

package org.heigit.ors.api.responses.routing.json;

import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;


public class JSONExtraSummary {
    private final double value;
    private final double distance;
    private final double amount;

    public JSONExtraSummary(double value, double distance, double amount) {
        this.value = value;
        this.distance = distance;
        this.amount = amount;
    }

    @Schema(description = "[Value](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/extra-info/) of a info category.", example = "5")
    @JsonProperty("value")
    public double getValue() {
        return value;
    }

    @Schema(description = "Cumulative distance of this value.", example = "123.1")
    @JsonProperty("distance")
    public double getDistance() {
        return distance;
    }

    @Schema(description = "Category percentage of the entire route.", example = "23.8")
    @JsonProperty("amount")
    public double getAmount() {
        return amount;
    }
}