com.google.api.services.spectrum.model.GeoLocationPolygon Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-spectrum Show documentation
There is a newer version: v1explorer-rev52-1.24.1
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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.
 */
/*
 * This code was generated by https://github.com/google/apis-client-generator/
 * (build: 2016-05-04 15:59:39 UTC)
 * on 2016-05-18 at 06:28:13 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.spectrum.model;

/**
 * A region is represented using the polygonal shape.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Google Spectrum Database API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GeoLocationPolygon extends com.google.api.client.json.GenericJson {

  /**
   * When the geolocation describes a region, the exterior field refers to a list of
   * latitude/longitude points that represent the vertices of a polygon. The first and last points
   * must be the same. Thus, a minimum of four points is required. The following polygon
   * restrictions from RFC5491 apply: - A connecting line shall not cross another connecting line of
   * the same polygon.  - The vertices must be defined in a counterclockwise order.  - The edges of
   * a polygon are defined by the shortest path between two points in space (not a geodesic curve).
   * Consequently, the length between two adjacent vertices should be restricted to a maximum of 130
   * km.  - All vertices are assumed to be at the same altitude.  - Polygon shapes should be
   * restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List exterior;

  static {
    // hack to force ProGuard to consider GeoLocationPoint used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GeoLocationPoint.class);
  }

  /**
   * When the geolocation describes a region, the exterior field refers to a list of
   * latitude/longitude points that represent the vertices of a polygon. The first and last points
   * must be the same. Thus, a minimum of four points is required. The following polygon
   * restrictions from RFC5491 apply: - A connecting line shall not cross another connecting line of
   * the same polygon.  - The vertices must be defined in a counterclockwise order.  - The edges of
   * a polygon are defined by the shortest path between two points in space (not a geodesic curve).
   * Consequently, the length between two adjacent vertices should be restricted to a maximum of 130
   * km.  - All vertices are assumed to be at the same altitude.  - Polygon shapes should be
   * restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
   * @return value or {@code null} for none
   */
  public java.util.List getExterior() {
    return exterior;
  }

  /**
   * When the geolocation describes a region, the exterior field refers to a list of
   * latitude/longitude points that represent the vertices of a polygon. The first and last points
   * must be the same. Thus, a minimum of four points is required. The following polygon
   * restrictions from RFC5491 apply: - A connecting line shall not cross another connecting line of
   * the same polygon.  - The vertices must be defined in a counterclockwise order.  - The edges of
   * a polygon are defined by the shortest path between two points in space (not a geodesic curve).
   * Consequently, the length between two adjacent vertices should be restricted to a maximum of 130
   * km.  - All vertices are assumed to be at the same altitude.  - Polygon shapes should be
   * restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
   * @param exterior exterior or {@code null} for none
   */
  public GeoLocationPolygon setExterior(java.util.List exterior) {
    this.exterior = exterior;
    return this;
  }

  @Override
  public GeoLocationPolygon set(String fieldName, Object value) {
    return (GeoLocationPolygon) super.set(fieldName, value);
  }

  @Override
  public GeoLocationPolygon clone() {
    return (GeoLocationPolygon) super.clone();
  }

}