com.google.maps.model.OpeningHours Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-maps-services Show documentation
Use the Google Maps API Web Services in Java! https://developers.google.com/maps/documentation/webservices/
There is a newer version: 2.2.0
/*
 * Copyright 2015 Google Inc. All rights reserved.
 *
 *
 * 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 com.google.maps.model;

import java.io.Serializable;
import java.time.LocalTime;
import java.util.Arrays;

/**
 * Opening hours for a Place Details result. Please see Place Details
 * Results for more details.
 */
public class OpeningHours implements Serializable {

  private static final long serialVersionUID = 1L;
  /**
   * Whether the place is open at the current time.
   *
   * Note: this field will be null if it isn't present in the response.
   */
  public Boolean openNow;

  /** The opening hours for a Place for a single day. */
  public static class Period implements Serializable {

    private static final long serialVersionUID = 1L;

    public static class OpenClose implements Serializable {

      private static final long serialVersionUID = 1L;

      public enum DayOfWeek {
        SUNDAY("Sunday"),
        MONDAY("Monday"),
        TUESDAY("Tuesday"),
        WEDNESDAY("Wednesday"),
        THURSDAY("Thursday"),
        FRIDAY("Friday"),
        SATURDAY("Saturday"),

        /**
         * Indicates an unknown day of week type returned by the server. The Java Client for Google
         * Maps Services should be updated to support the new value.
         */
        UNKNOWN("Unknown");

        private DayOfWeek(String name) {
          this.name = name;
        }

        private final String name;

        public String getName() {
          return name;
        }
      }

      /** Day that this Open/Close pair is for. */
      public Period.OpenClose.DayOfWeek day;

      /** Time that this Open or Close happens at. */
      public LocalTime time;

      @Override
      public String toString() {
        return String.format("%s %s", day, time);
      }
    }

    /** When the Place opens. */
    public Period.OpenClose open;

    /** When the Place closes. */
    public Period.OpenClose close;

    @Override
    public String toString() {
      return String.format("%s - %s", open, close);
    }
  }

  /** Opening periods covering seven days, starting from Sunday, in chronological order. */
  public Period[] periods;

  /**
   * The formatted opening hours for each day of the week, as an array of seven strings; for
   * example, {@code "Monday: 8:30 am – 5:30 pm"}.
   */
  public String[] weekdayText;

  /**
   * Indicates that the place has permanently shut down.
   *
   * Note: this field will be null if it isn't present in the response.
   */
  public Boolean permanentlyClosed;

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder("[OpeningHours:");
    if (permanentlyClosed != null && permanentlyClosed) {
      sb.append(" permanentlyClosed");
    }
    if (openNow != null && openNow) {
      sb.append(" openNow");
    }
    sb.append(" ").append(Arrays.toString(periods));
    return sb.toString();
  }
}