info.tomfi.hebcal.shabbat.request.ParamKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hebcal-api Show documentation

A Java API encapsulating HebCal's REST API.

There is a newer version: 2.1.9

/*
 * Copyright Tomer Figenblat.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package info.tomfi.hebcal.shabbat.request;

/** Enum used to encapsulate the various available query paramter names. */
public enum ParamKey {
  ASHKENAZIS_TRANSLITERATIONS("a"),
  CANDLE_LIGHTING("b"),
  CITY("city"), // used with GeoType.CITY
  GEO_ID("geonameid"), // used with GeoType.GEO_NAME
  GEO_TYPE("geo"),
  GREGORIAN_DAY("gd"),
  GREGORIAN_MONTH("gm"),
  GREGORIAN_YEAR("gy"),
  HAVDALAH("m"),
  INCLUDE_TURAH_HAFTARAH("leyning"),
  LATITUDE("latitude"), // used with GeoType.POSITIONAL
  LONGITUDE("longitude"), // used with GeoType.POSITIONAL
  OUTPUT_FORMAT("cfg"),
  TZID("tzid"), // used with GeoType.POSITIONAL
  ZIP("zip"); // used with GeoType.ZIP

  private final String key;

  ParamKey(final String setKey) {
    key = setKey;
  }

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