Deprecate TypedMap symbols and replace with named functions

[BillyAutrey]

Pull Request Checklist

• Have you read How to write the perfect pull request?
• Have you read through the contributor guidelines?
• Have you referenced any issues you're fixing using commit message keywords?
• Have you added copyright headers to new files?
• Have you checked that both Scala and Java APIs are updated?
• Have you updated the documentation for both Scala and Java sections?
• Have you added tests for any changed functionality?

Helpful things

Fixes

Fixes #10221

Purpose

• Deprecates - and + Scala symbol methods in TypedMap.
• Adds updated and removed functions that serve the same purpose.
• Changes outside calls to +, -, $plus, and $minus to updated/removed.
• Adds an ignore rule for MiMa compatibility - new signature doesn't break backwards compatibility.

In the future, postfix symbolic operators are going to be deprecated for methods with multiple parameters. Thus, this change is necessary to meet that need. The original ticket suggests removing all of those operators.

Background Context

I opted to deprecate the old methods, in case others are using them.

[BillyAutrey]

Next commit will update usages of TypedMap.+() and TypedMap.-() through the code base. Just want to get feedback on this approach first.

[mkurz]

So I had a look at #10199 again and the three + and - method were actually only added in that PR, which was never backported to 2.8.x. That means we would actually introduce already deprecated methods in Play 2.9 😉 That does not make sense of course so I just removed them now (in the first commit I just pushed).

The same is true for the addAttrs(varargs) method of the Play Java API, I does not yet exist in Play 2.8.x. Since it does cause some problems like

• we have to workaround Bug overriding varargs method defined both in Scala class and Java interface, while also narrowing return type scala/bug#11944
• and it is causing troubles for Scala 3 support (see scala3 compilation for PlayProject #11550, you already commented there)

I think its best to just remove it for now to make our lifes easier. I don't think someone will miss it. Actually I was the one who introduced it for a project I was working on back then. However, it's "just" useful for the Java api, and we still keep the addAttrs(java.util.List) method, so it's still possible to pass an array via addAttrs(Arrays.asList(...))

I also updated the mima filters in the last PR.

Let's merge this and then we can rebase the Scala PR without the duplicate RequestImpl class on it.

[mkurz]

btw, I was using git difftool 2.8.x -- core/play/src/main/scala/play/api/libs/typedmap/TypedMap.scala core/play/src/main/java/play/mvc/Http.java core/play/src/main/scala/play/core/j/JavaHelpers.scala how the files from the 2.8.x branch differ from the main branch/your pr.

[mkurz]

Removing addAttrs(entries: TypedEntry[_]*) allows us to get rid of this workaround for the mentioned Scala "bug" and makes life easiser for #11550

[mkurz]

LGTM, thanks Billy!