Skip to content
This repository has been archived by the owner on Sep 24, 2019. It is now read-only.

Improve Java API #40

Open
nbargnesi opened this issue Aug 9, 2012 · 0 comments
Open

Improve Java API #40

nbargnesi opened this issue Aug 9, 2012 · 0 comments
Assignees
@nbargnesi
Labels
enhancement
Milestone
3.0.0

Comments

@nbargnesi
Copy link
Member

A number of improvements to the Java API need to be made to integrate the framework into different Java application stacks. This includes changes like programmatic system configurations (d0cc99b) and fixing the KAM APIs.

Any improvements should follow these guidelines:

  • Documented in API documentation, possibly readthedocs
  • Commits should reference this issue
  • UPGRADING should be updated, as needed
  • CHANGELOG should be updated, as needed
@ghost ghost assigned nbargnesi Aug 9, 2012
nbargnesi pushed a commit to nbargnesi/openbel-framework that referenced this issue Aug 10, 2012
Improve the KAM store API; see OpenBEL#40
83b85d0 
Summary:
* KamStore -> KAMStore
* KamStoreImpl -> KAMStoreImpl
* KamStoreException -> KAMStoreException
* KAMStore API changes (aims to be as backwards compatible as possible)
    - added exists methods to check for KAM availability
    - readCatalog -> getCatalog
    - getCatalog never throws exceptions
    - KAMStoreException is an unchecked exception to indicate a severe
      problem vice the old use of these exceptions which was admittedly
      poor
    - Improved documentation; which arguments are optional, which
      required, specific behavior, etc.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@nbargnesi nbargnesi

Labels
enhancement
Projects
None yet
Milestone
3.0.0
Development

No branches or pull requests
1 participant
@nbargnesi