cancel
Showing results for 
Search instead for 
Did you mean: 

Javadoc vs. Implementation beans

frederic_dernba
Champ in-the-making
Champ in-the-making
Hello,

I'm new to activity and is looking at the opportunity to use it for major application of BNP Paribas (evaluating informelly first).

I have installed the demo. It runs fine. Now, i'm looking at integration hurdles given our current runtime environment and pre-requesites regarding integration constraintsm, quality and security. I'm also looking at the documentation of the product.

For this purpose, I'd like to know why Javadoc provides documentation about interfaces only ?.

Where are the implementation beans documented ? As an experimented Spring user, you want the implementation beans to appear in the javadoc.

Cheers,

Fred
2 REPLIES 2

ronald_van_kuij
Champ on-the-rise
Champ on-the-rise
The interfaces are the 'api' and thus 'stable' implementation classes should only be used in exceptional circumstances.

frederikherema1
Star Contributor
Star Contributor
Ronald is right. If you want to use the Activiti API, all you really need to have are the interface javadocs.

If you want to go deeper into the implementation-details and extensions, check out the user guide. Or use the Activiti-sources, this contains all code and potential javadocs for impl-classes only. Please note that not all implementation-classes are properly javadocced, since they are "internal" as opposed to public API which we try to keep thoroughly documented.