[jbossts-issues] [JBoss JIRA] (JBTM-758) Errors in documentation: Transaction Core Programmers Guide

Errors in documentation: Transaction Core Programmers Guide ----------------------------------------------------------- Key: JBTM-758 URL: https://issues.jboss.org/browse/JBTM-758 Project: JBoss Transaction Manager Issue Type: Bug Security Level: Public(Everyone can see) Components: Documentation Affects Versions: 4.11.0 Reporter: Mauro Molinari Assignee: Michael Musgrove Priority: Minor Fix For: 4.17.0 I'm going to highlight some errors I found during the reading of the Transaction Core Programmers Guide (TX-PG-5/11/10): - page 31: when describing LogManager: "The *shared* parameter only has meaning if *ot* is RECOVERABLE"; actually the two parameters are named *objectModel* and *ObjectType* respectively in the caption of the paragraph - page 36: in the example, I think the line with "A.add(new ShutdownRecord(...)" is not pertinent - page 64: the last sentence says that the issues described in that paragraph will be addressed in the next section, but the next section is about configuration - page 65: the second paragraph has some typographic problem (<module>propertyManager, <name>EnvironmentBean) - page 69: in the second paragraph: "All of the implementations are derived from the ObjectStore interface"; actually, ObjectStore is a class to extend, not an interface to implement Lastly, an observation about the depiction of finalizers as "destructors": in this guide, the finalize method is considered a destructor. However, in Java it is not actually. Anyway, it's not clear if calling terminate() in the finalize() is mandatory or not. If so, why isn't it called directly in com.arjuna.ats.arjuna.StateManager.finalize()? If not, I have another doubt. In all the examples of user classes (i.e. page 60) the finalize() is implemented as: public void finalize() { super.terminate(); } However, super.finalize() is not called. Isn't it risky? I mean, in this way the code in com.arjuna.ats.arjuna.StateManager.finalize() is never called... I think the documentation should be more clear on this subject.