[CALCITE-4927] Remove deprecated RelBuilder#groupKey(ImmutableBitSet, ImmutableList) clashing with new replacement API

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.28.0
• Fix Version/s: 1.29.0
• Component/s: core
• Labels: pull-request-available
• Assignee: Stamatis Zampetakis
• Reporter: Stamatis Zampetakis
• Created: 08/Dec/21 15:28
• Updated: 04/Jan/22 08:27
• Resolved: 04/Jan/22 08:27

Description

The RelBuilder#groupKey(ImmutableBitSet, ImmutableList) API is marked for removal before 2.0.

/** @deprecated Use {@link #groupKey(ImmutableBitSet)}
   * or {@link #groupKey(ImmutableBitSet, Iterable)}. */
  @Deprecated // to be removed before 2.0
  public GroupKey groupKey(ImmutableBitSet groupSet,
      @Nullable ImmutableList<ImmutableBitSet> groupSets)

I would suggest to remove it ASAP due to the fact that it clashes with the new replacement API.

public GroupKey groupKey(ImmutableBitSet groupSet,
      Iterable<? extends ImmutableBitSet> groupSets)

Leaving it as is creates ambiguity and requires everybody to upcast to Iterable if they want to use the new API.

Removing it on the other hand does not seem to affect much backward compatibility since callers will automatically use the new API with no changes required in their code.

The main difference is that the deprecated API allows groupSets to be null but if we care so much we can also make the new API to be more permissive.

Issue Links

• links to: GitHub Pull Request #2635