Bug 4645 - Decider Javadoc language on exitStatus is misleading
Decider Javadoc language on exitStatus is misleading
Status: RESOLVED FIXED
Product: jbatch
Classification: Unclassified
Component: source
1
PC Windows
: P5 enhancement
: ---
Assigned To: cvignola
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-02-05 17:44 UTC by ScottKurz
Modified: 2013-03-01 14:34 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description ScottKurz 2013-02-05 17:44:23 UTC
The Decider interface Javadoc repeates says in three method-level places (actually one whole method block is a dup):

"The return value updates the current job execution's exit status. "

That's misleading, since it's better described at the class-level Javadoc:

" * The decider returns a String value which becomes the exit 
 * status value on which the decision chooses the next transition. "
Comment 1 cvignola 2013-03-01 14:34:40 UTC
We have reduced the number of methods on decider to exactly one.  The class level java doc will be updated consistent with what you suggest.  Change will be in PFD v1.5.