vaadin/framework

Deprecate MultiSelectionEvent.getNewSelection

Open

#11,756 opened on Oct 23, 2019

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Java (715 forks)auto 404
Help wantedStale

Repository metrics

Stars
 (1,806 stars)
PR merge metrics
 (PR metrics pending)

Description

Description copied from https://github.com/vaadin/flow/issues/6756

The class has three methods for the same thing:

Set<T> getValue()
Set<T> getAllSelectedItems()
Set<T> getNewSelection()

The first two are inherited, but getNewSelection exists only in MultiSelectionEvent.

Another reason to deprecate it is that the naming can cause confusion. We got feedback that a user expected the method to return the newly added items (compared to the old selection), i.e. what getAddedSelection returns.

JavaDocs should suggest to use getAllSelectedItems or getValue instead.

Contributor guide

Research direction
Add @Deprecated annotation to getNewSelection() and update JavaDocs to recommend using getAllSelectedItems() or getValue() instead.
Tech stack
java
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80