org.springframework.data.geo.Polygon.java Source code

Introduction

Here is the source code for org.springframework.data.geo.Polygon.java

Source

/*
 * Copyright 2011-2019 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.data.geo;

import lombok.EqualsAndHashCode;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.springframework.data.annotation.PersistenceConstructor;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
 * Simple value object to represent a {@link Polygon}.
 *
 * @author Oliver Gierke
 * @author Thomas Darimont
 * @since 1.8
 */
@EqualsAndHashCode
public class Polygon implements Iterable<Point>, Shape {

    private static final long serialVersionUID = -2705040068154648988L;

    private final List<Point> points;

    /**
     * Creates a new {@link Polygon} for the given Points.
     *
     * @param x must not be {@literal null}.
     * @param y must not be {@literal null}.
     * @param z must not be {@literal null}.
     * @param others
     */
    public Polygon(Point x, Point y, Point z, Point... others) {

        Assert.notNull(x, "X coordinate must not be null!");
        Assert.notNull(y, "Y coordinate must not be null!");
        Assert.notNull(z, "Z coordinate must not be null!");
        Assert.notNull(others, "Others must not be null!");

        List<Point> points = new ArrayList<>(3 + others.length);
        points.addAll(Arrays.asList(x, y, z));
        points.addAll(Arrays.asList(others));

        this.points = Collections.unmodifiableList(points);
    }

    /**
     * Creates a new {@link Polygon} for the given Points.
     *
     * @param points must not be {@literal null}.
     */
    @PersistenceConstructor
    public Polygon(List<? extends Point> points) {

        Assert.notNull(points, "Points must not be null!");

        List<Point> pointsToSet = new ArrayList<>(points.size());

        for (Point point : points) {

            Assert.notNull(point, "Single Point in Polygon must not be null!");
            pointsToSet.add(point);
        }

        this.points = Collections.unmodifiableList(pointsToSet);
    }

    /**
     * Returns all {@link Point}s the {@link Polygon} is made of.
     *
     * @return
     */
    public List<Point> getPoints() {
        return this.points;
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Iterable#iterator()
     */
    public Iterator<Point> iterator() {
        return this.points.iterator();
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return String.format("Polygon: [%s]", StringUtils.collectionToCommaDelimitedString(points));
    }
}