ShapeReader.read(String)

Open
#129 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
api

Research direction

Start by reviewing ShapeReader.read(Object), readIfSupported(Object), and read(Reader), then compare how existing implementations convert inputs to String and handle IOException. Done means the API decision is resolved for the proposed String-based methods, including whether read(Reader) should change.

Written by the indexing model from the issue text.

Description

I think ShapeReader.read(String) should exist, and furthermore should not throw IOException. Contrast this to the existing read(Object) defined now which does throw IOException and every implementation converts it to a String. I propose both read(Object) and readIfSupported(Object) be changed to be String based and to not throw IOException. read(Reader) is debatable... I wonder if it's worthwhile to bother.

@jdeolive @ryantxu what do you think?

Dominant language
Java
Stars
961
Forks
172
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from locationtech/spatial4j

All issues in locationtech/spatial4j

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.