Adding coordAll() versions for Feature, FeatureCollection, and Geometry parameters

[langsmith]

This pr adds methods for getting a List<Point> from a Feature, FeatureCollection, or Geometry. These parameters were missing from our Turf for Java library, but are part of https://turfjs.org/docs/#coordAll .

Having these methods will be incredibly helpful for adding a number of new Turf methods to our Turf for Java library. Also unblocks #1007.

[osana]

The library should not add overhead. No need to create FeatureCreation.

[osana]

This will result in extra Lists creates (one per feature).
We could have a helper method that would add to existing list

private static List<Point>  addCoordAll(@NonNull List<Point> pointList, @NonNull Feature feature)

and

public static List<Point> coordAll(@NonNull Feature feature) {
    return addCoordAll(new ArrayList<Point>, @NonNull Feature feature);
}

[osana]

We want to avoid having ArrayLists created. To do so we need to have "shadow" methods for almost all public coordAll() methods.
You can keep the same name for the method. The only difference will be that the method does not create an ArrayList but instead addes points from passed in Feature or Geometry to the passed in List

I think the code snippets in the review will be sefl explanatory.

[osana]

Here is one way to approach the implementation and to avoid unneeded ArrayList() creattion.
We have public coorAll methods for all Geometries. We can add private versions that take List as an extra parameter. See the example below:

public static List<Point> coordAll(@NonNull Polygon polygon, boolean excludeWrapCoord) {
     return coordAll(new ArrayList<Point>(), polygon, excludeWrapCoord);
  }

  private  static List<Point> coordAll(@NonNull List<Point> coords,
                                       @NonNull Polygon polygon, boolean excludeWrapCoord) {
    int wrapShrink = excludeWrapCoord ? 1 : 0;

    for (int i = 0; i < polygon.coordinates().size(); i++) {
      for (int j = 0; j < polygon.coordinates().get(i).size() - wrapShrink; j++) {
        coords.add(polygon.coordinates().get(i).get(j));
      }
    }
    return coords;
  }

[langsmith]

Ahhhh, I see now. Got it.

The changes above would break semver, correct? Or to preserve, could we just deprecate the current public static List<Point> coordAll(@NonNull Polygon polygon, boolean excludeWrapCoord) { and create a new coordAll(@NonNull Polygon polygon, boolean excludeWrapCoord) as you've done above?

[osana]

We are actually not breaking semver-major as only private static methods are added. It is a semver-minor change as new APIs are added.

[osana]

It should be just:
addCoordAll(finalCoordsList, singleFeature);

[osana]

Add `List to the list of parameters, then it will look something like:

  private static List<Point> coordAll(@NonNull List<Point> pointList, @NonNull Geometry geometry) {
    if (geometry instanceof Point) {
      pointList.add((Point) geometry);

    } else if (geometry instanceof MultiPoint) {
      pointList.addAll(((MultiPoint)geometry).coordinates());

    } else if (geometry instanceof LineString) {
      pointList.addAll(((LineString)geometry).coordinates());

    } else if (geometry instanceof MultiLineString) {
      coordAll(pointList, (MultiLineString) geometry);

    } else if (geometry instanceof Polygon) {
      coordAll(pointList, (Polygon) geometry);

    } else if (geometry instanceof MultiPolygon) {
      coordAll(pointList, (MultiPolygon) geometry);

    } else if (geometry instanceof GeometryCollection) {
      // recursive
      for (Geometry singleGeometry : ((GeometryCollection) geometry).geometries()) {
        coordAll(pointList, singleGeometry);
      }
    }
    return pointList;
  }

[osana]

This should be :
return coordAll(pointList, feature.geometry());

[langsmith]

Ok @osana , just pushed two commits that address your feedback above. Mainly added the code that you suggested above. I had to add a @NonNull boolean excludeWrapCoord parameter to the Feature & FeatureCollection methods because the boolean is needed in

 else if (geometry instanceof Polygon) {
      coordAll(pointList, (Polygon) geometry, excludeWrapCoord);

    } else if (geometry instanceof MultiPolygon) {
      coordAll(pointList, (MultiPolygon) geometry, excludeWrapCoord);

    } else if (geometry instanceof GeometryCollection) {
      // recursive
      for (Geometry singleGeometry : ((GeometryCollection) geometry).geometries()) {
        coordAllFromSingleGeometry(pointList, singleGeometry, excludeWrapCoord);
      }
    }

Anyways. Let me know how things look now.

[osana]

Looking good. I think it is almost there.
Newly added methods should have @NonNull return annotation as do the public methods.

[osana]

We are actually not breaking semver-major as only private static methods are added. It is a semver-minor change as new APIs are added.

[langsmith]

Ok @osana . Just pushed and rebased. Added the @NonNull annotations where needed and also adjusted mentions of @since 4.7.0 to @since 4.8.0.

[osana]

Looks like one @nonnull got missed

[osana]

@nonnull