[jira] [Commented] (GEOMETRY-27) OrientedPoint API Cleanup

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Commented] (GEOMETRY-27) OrientedPoint API Cleanup

JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/GEOMETRY-27?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16764428#comment-16764428 ]

Matt Juntunen commented on GEOMETRY-27:

Note that in the course of updating the API here, I found that I wanted an exception class to indicate that a value passed to a method is programmatically correct but contains an invalid geometric value. So, I made {{GeometryValueException}}, which extends {{GeometryException}}. {{IllegalNormException}} is now a subclass of {{GeometryValueException}} instead of {{GeometryException}}.

> OrientedPoint API Cleanup
> -------------------------
>                 Key: GEOMETRY-27
>                 URL: https://issues.apache.org/jira/browse/GEOMETRY-27
>             Project: Apache Commons Geometry
>          Issue Type: Wish
>            Reporter: Matt Juntunen
>            Priority: Major
>              Labels: pull-request-available
>          Time Spent: 10m
>  Remaining Estimate: 0h
> The following changes should be made to the {{OrientedPoint}} class:
>  - replace {{direct}} boolean with {{direction}} {{Vector1D}} instance. The "direct" terminology is not clear to most users and having a vector to indicate the orientation of the point is much more intuitive and easier to work with.
>  - add {{equals}}, {{hashCode}}, and {{toString}}
>  - make the class immutable.
>  - update documentation to be more accessible.
> Pull request: https://github.com/apache/commons-geometry/pull/27

This message was sent by Atlassian JIRA