org.geolatte.geom.PositionSequenceBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geolatte-geom Show documentation

This geoLatte-geom library offers a geometry model that conforms to the OGC Simple Features for SQL specification.

The newest version!

/*
 * This file is part of the GeoLatte project.
 *
 *     GeoLatte is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     GeoLatte is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with GeoLatte.  If not, see .
 *
 * Copyright (C) 2010 - 2011 and Ownership of code is shared by:
 * Qmino bvba - Romeinsestraat 18 - 3001 Heverlee  (http://www.qmino.com)
 * Geovise bvba - Generaal Eisenhowerlei 9 - 2140 Antwerpen (http://www.geovise.com)
 */

package org.geolatte.geom;

import java.util.Collection;

/**
 * A builder for PositionSequences.
 *
 * {@code PositionSequences} are built by adding points in order.
 *
 * @author Karel Maesen, Geovise BVBA, 2011
 */
public interface PositionSequenceBuilder {

    /**
     * Adds a Position to the PositionSequence being built.
     *
     * @param coordinates the coordinates of the Position that is added
     * @return this instance
     */
    PositionSequenceBuilder
 add(double... coordinates);

    default PositionSequenceBuilder
 addAll(Collection
 positions) {
        positions.forEach(this::add);
        return this;
    }

    /**
     * Adds a {@code} Position to the PositionSequence being built.
     * @param position the position that is added
     * @return this instance
     */
    PositionSequenceBuilder
 add(P position);

    /**
     * Returns the result of this builder.
     *
     * @return the PositionSequence that has been built by this builder instance.
     * @throws IllegalStateException when the construction of the PositionSequence has not yet been completed.
     */
    PositionSequence toPositionSequence();

    /**
     * Returns the number of positions that have already been added.
     * @return the number of positions that have already been added.
     */
    int getNumAdded();
}