[WICKET-6892] CookieUtils save method: incomplete javadoc

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Won't Fix
• Affects Version/s: 8.12.0
• Component/s: wicket-core
• Labels: easyfix javadoc
• Assignee: Unassigned
• Reporter: Michel Trefcon
• Created: 28/May/21 17:18
• Updated: 25/Jun/21 11:51
• Resolved: 25/Jun/21 11:51

Description

The java doc of the CookieUtils.save method is 'Create a Cookie with key and value and save it in the browser with the next response' ( https://github.com/apache/wicket/blob/rel/wicket-8.12.0/wicket-core/src/main/java/org/apache/wicket/util/cookies/CookieUtils.java#L147 ).

But when we look to the source code, it doesn't only create the cookie, it updates the cookie if it exists.
it may confuse a developer a little bit.

The javadoc fix could be  'Create a Cookie with key and value or update the Cookie value if the Cookie exists and save it in the browser with the next response'.

We could rename the method save into createOrUpdate but this would break the backward compatibility.