Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IMap contract should describe how it interacts with Map{Loader/Store} #10969

Closed
jerrinot opened this issue Jul 24, 2017 · 0 comments
Closed

IMap contract should describe how it interacts with Map{Loader/Store} #10969

jerrinot opened this issue Jul 24, 2017 · 0 comments

Comments

@jerrinot
Copy link
Contributor

@jerrinot jerrinot commented Jul 24, 2017

The IMap contract does not describe its interactions with MapLoader/MapStore.
If a method consults MapStore then it should be clearly documented.

For example: Some users find it surprising put() calls MapLoader. This should be described and and we could also show an alternative - the set() method - which does not invoke the MapLoader.

Another example:

[...]
     *  The <tt>key</tt> will first be searched for in memory. If the key is not
     * found, and if a key is attributed, a {@link MapLoader} will then attempt to load the key.
     * </p>
[...]
    boolean containsKey(Object key);

I don't understand what's the meaning of "and if a key is attributed"

@jerrinot jerrinot added this to the 3.10 milestone Jul 24, 2017
@Holmistr Holmistr added the DR2 label Dec 8, 2017
@vbekiaris vbekiaris self-assigned this Dec 12, 2017
@blazember blazember assigned blazember and unassigned vbekiaris Jan 15, 2018
blazember added a commit to blazember/hazelcast that referenced this issue Jan 17, 2018
blazember added a commit to blazember/hazelcast that referenced this issue Jan 19, 2018
Define for each IMap method in its javadoc that
- how the given method interacts with MapStore and MapLoader if there is any interaction
- whether the exceptions from MapStore/MapLoader implementations are propagated or not
- if there is a significant performance impact to be aware of when calling the method on an IMap backed by a data store
- if there is an alternative method that does similar work but with different data store interactions

Fixes hazelcast#10969
blazember added a commit to blazember/hazelcast that referenced this issue Jan 19, 2018
Define for each IMap method in its javadoc that
- how the given method interacts with MapStore and MapLoader if there is any interaction
- whether the exceptions from MapStore/MapLoader implementations are propagated or not
- if there is a significant performance impact to be aware of when calling the method on an IMap backed by a data store
- if there is an alternative method that does similar work but with different data store interactions

Fixes hazelcast#10969
blazember added a commit to blazember/hazelcast that referenced this issue Jan 19, 2018
Define for each IMap method in its javadoc that
- how the given method interacts with MapStore and MapLoader if there is any interaction
- whether the exceptions from MapStore/MapLoader implementations are propagated or not
- if there is a significant performance impact to be aware of when calling the method on an IMap backed by a data store
- if there is an alternative method that does similar work but with different data store interactions

Fixes hazelcast#10969
@taburet taburet added Team: Core and removed Team: Core labels Jan 22, 2018
blazember added a commit to blazember/hazelcast that referenced this issue Jan 30, 2018
Define for each IMap method in its javadoc that
- how the given method interacts with MapStore and MapLoader if there is any interaction
- whether the exceptions from MapStore/MapLoader implementations are propagated or not
- if there is a significant performance impact to be aware of when calling the method on an IMap backed by a data store
- if there is an alternative method that does similar work but with different data store interactions

Fixes hazelcast#10969
@Holmistr Holmistr added DR3 and removed DR2 labels Feb 2, 2018
mmedenjak added a commit that referenced this issue Feb 8, 2018
Define for each IMap method in its javadoc that
- how the given method interacts with MapStore and MapLoader if there is any interaction
- whether the exceptions from MapStore/MapLoader implementations are propagated or not
- if there is a significant performance impact to be aware of when calling the method on an IMap backed by a data store
- if there is an alternative method that does similar work but with different data store interactions

Fixes #10969
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

6 participants
You can’t perform that action at this time.