chore: rename @ShadowVariableLooped to @ShadowVariableInconsistent

[Christopher-Chianelli]

• Solving will automatically update all shadow variables, so you can now pass in solutions with incorrect/stale shadow variables and they'll be correctly updated.

• SolutionManager.update(SolutionUpdatePolicy.UPDATE_SCORE_ONLY, ...) will now fail fast if any @ShadowVariableInconsistent member is null or if any @InverseRelationVariable is null or incorrect.

[triceo]

I have not done a full review yet. The changes I'm requesting will alter this PR enough that I will re-review from scratch when done.

[triceo]

Also, I wonder... the performance impact of this could be mitigated if we know that these checks will be done elsewhere. If we know that var listeners will be triggered, and that those have all of those assertions, can we not skip this work?

[Christopher-Chianelli]

Var listeners will not be triggered, since this code is only run for SolutionManager.update(SolutionUpdatePolicy.UPDATE_SCORE_ONLY, ...), which skip variable listener calls.

The code doesn't make that at all clear. There is no comment, nor does the structure of the code suggests that. If we moved this code to a place where the SolutionManager.update() happens, there could be no discussion. But since the correct place for this is probably in the score director for performance reasons, at least there ought to be a series of comments explaining the purpose of this.

[triceo]

Leaving my review.

I also pushed a small commit adding Javadocs to the methods that have to do with update policies. I figured it'd be more effective to do it than to spend even more time explaining it so that you can do it.

[triceo]

Also, tests are failing.

[triceo]

Having reviewed the Sonar suggestions, I'd say they're useful.

[triceo]

I have just added my final comment. Once that's resolved, I'll approve, provided that those changes don't result in anything questionable.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
91.2% Coverage on New Code
3.5% Duplication on New Code

See analysis details on SonarQube Cloud