com.github.marcoshsc.orsApiTools.directions.parameters.Preference Maven / Gradle / Ivy

Go to download

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

Java library that provides implementation of Open Route Service endpoints.

There is a newer version: 2.2.2

package com.github.marcoshsc.orsApiTools.directions.parameters;

import com.github.marcoshsc.orsApiTools.directions.enums.PreferenceEnum;
import com.github.marcoshsc.orsApiTools.general.enums.ORSEnum;
import com.github.marcoshsc.orsApiTools.general.superclasses.EnumParameter;

/**
 * 
 * References the "preference" query parameter, used on GET requests to the ORS API.
 * The parameter is described as in the ORS API Documentation below:
 * 	"Specifies the route preference."
 * 
 * Makes use of PreferenceEnum to map the possible values.
 * 
 * @see PreferenceEnum to see the possible values.
 * 
 * The default value is "fastest"
 * 
 * @author Marcos Henrique Santos Cunha in March 11th, 2020
 *
 */
public class Preference extends EnumParameter {
	
	private final String name = ORSEnum.PREFERENCE_PARAM.toString();

	public Preference(PreferenceEnum value) {
		super(value);
	}

	@Override
	public String getName() {
		return name;
	}

}