[
https://issues.apache.org/jira/browse/IGNITE-4795?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15945603#comment-15945603
]
Andrey Gura edited comment on IGNITE-4795 at 3/28/17 5:37 PM:
--------------------------------------------------------------
[~SomeFire],
I've reviewd your changes and have a couple comments:
* {{TransactionException}} class. Please javadoc for constructors and linked
items ({{link}} javadoc tag). Also header with Apache license should be added.
* {{TransactionException}} class. And javadoc that makes some clarification
about transactional behaviour. See issue description, item 3: "Make extensive
documentation in the header of TransactionException to get understanding of
transactional and non-transactional methods behaviour."
* {{TransactionDeadlockException}} class. Unused import.
* {{TransactionHeuristicException}} class. Unused import.
* {{TransactionOptimisticException}} class. Unused import.
* {{TransactionRollbackException}} class. Unused import.
* {{TransactionTimeoutException}} class. Unused import.
* {{Transaction}} class. Please, rollback your changes. This interface should
not be chnaged.
* {{IgniteCache}} class. Please improve javadoc ("Transactions paragraph").
Just describe that transactional methods throw {{TransactionException}}.
* {{IgniteCache}} class. Please replace in javadoc items like this {{@see
org.apache.ignite.transactions.TransactionException}} to {{throws}} tags,
document this tags and add {{TransactionException}} to {{throws}} clause for
all transactional methods.
* {{IgniteCache}} class. Please merge latest changes from master into your
branch and make similar changes for methods for {{Async}} suffix.
was (Author: agura):
[~SomeFire],
I've reviewd your changes and have a couple comments:
* {{TransactionException}} class. Please javadoc for constructors and linked
items ({{link}} javadoc tag). Also header with Apache license should be added.
* {{TransactionException}} class. And javadoc that makes some clarification
about transactional behaviour. See issue description, item 3: "Make extensive
documentation in the header of TransactionException to get understanding of
transactional and non-transactional methods behaviour."
* {{TransactionDeadlockException}} class. Unused import.
* {{TransactionHeuristicException}} class. Unused import.
* {{TransactionOptimisticException}} class. Unused import.
* {{TransactionRollbackException}} class. Unused import.
* {{TransactionTimeoutException}} class. Unused import.
* {{Transaction}} class. Please, rollback your changes. This interface should
not be chnaged.
* {{IgniteCache}} class. Please improve javadoc ("Transactions paragraph").
Just describe that transactional methods throw {{TransactionException}}.
* {{IgniteCache}} class. Please replace in javadoc items like this {{@see
org.apache.ignite.transactions.TransactionException}} to {{throws}} tags,
document this tags and add {{TransactionException}} to {{throws}} clause for
all transactional methods.
* {{IgniteCache}} Please merge latest changes from master into your branch and
make similar changes for methods for {{Async}} suffix.
> Inherit TransactionException and update Javadoc
> -----------------------------------------------
>
> Key: IGNITE-4795
> URL: https://issues.apache.org/jira/browse/IGNITE-4795
> Project: Ignite
> Issue Type: Improvement
> Components: cache, SQL, website
> Affects Versions: 1.8
> Reporter: Alexandr Kuramshin
> Assignee: Ryabov Dmitrii
> Labels: documentation, important
> Fix For: 2.0
>
>
> Understanding transactional behaviour is not clear in Javadoc at this point
> of time. Even after reading website some doubt remain.
> Proposal.
> 1. Create {{TransactionException}} as the marker of transactional methods and
> inherit from it all the existed transactional exceptions like
> {{TransactionTimeoutException}}, {{TransactionRollbackException}},
> {{TransactionHeuristicException}}, {{TransactionOptimisticException}}, etc.
> 2. Update all the transactional methods ({{get}}, {{put}}, {{invoke}}, etc)
> as throwing the base {{TransactionException}}. Comment all the
> {{IgniteCache}} methods whether they are transactional or not, add {{@see
> TransactionException}} annotation.
> 3. Make extensive documentation in the header of {{TransactionException}} to
> get understanding of transactional and non-transactional methods behaviour.
> 4. Update website and Javadoc to clarify the fact that {{put}} value is
> cached within the transaction and affects successive {{get}}.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
