Opened 13 years ago

Closed 7 years ago

#9 closed enhancement (fixed)

Java API is non-standard

Reported by: jec@… Owned by: jng
Priority: medium Milestone: 2.5
Component: Web API Version:
Severity: major Keywords:
Cc: External ID: 916041

Description (last modified by robertbray)

The Java API generated by the SWIG toolkit does not conform to the standards and conventions used in Java programming. The SWIG java configuration should be changed to do the following

  1. method calls should being with lowercase letters
  1. methods should not call unchecked exceptions. Easiest thing to do would be for exceptions to extend RuntimeException instead of Exception
  1. collection classes should implement collection interface from java.util
  1. javadoc comments with API docs embedded into the source files. Source files distributed with installation so that developers using IDEs can leverage full power of IDE

Note that I don't think that this can be done and still maintain backward compatibility with existing API.

Change History (5)

comment:1 Changed 13 years ago by tomfukushima

External ID: 916041

comment:2 Changed 13 years ago by robertbray

Description: modified (diff)
Type: defectenhancement

If possible we should look at changing the code to generate both the new "enhanced" and old "crufty" Java wrappers. That would provide a resolution to the compatibility issues created by changing the API.

comment:3 Changed 7 years ago by jng

Owner: set to jng

comment:4 Changed 7 years ago by jng

Milestone: 2.5

comment:5 Changed 7 years ago by jng

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.