Skip to content

docs: say what getQueue() and getSorter() return for a priority queue configuration - #6

Merged
Bonajo merged 1 commit into
mainfrom
chore/postpone-radix-sorter
Nov 19, 2026
Merged

Bonajo merged 1 commit into
mainfrom
chore/postpone-radix-sorter

Conversation

@Bonajo

@Bonajo Bonajo commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

The radix sorter assignment is postponed. This PR takes the javadoc fix from feature/radix-sorter without the key sorter parts:

  • getQueue() returns null for a configuration with a priority queue.
  • getSorter() returns a pass-through sorter for a priority queue configuration, since the priority queue sorts by itself.

Docs only, so no version bump is needed. mvn clean verify passes and javadoc gives no warnings. The KeySorter / SortKind.RADIX work stays on feature/radix-sorter for later.

… configuration

getQueue() returns null for a configuration with a priority queue, and
getSorter() returns a pass-through sorter, since the priority queue
sorts by itself.
Copilot AI balanced review requested due to automatic review settings November 19, 2026 13:21
@Bonajo
Bonajo merged commit ba76b79 into main Nov 19, 2026
2 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The pass-through sorter can return an unsorted or differently ordered queue, violating the contract to use the supplied comparator.

1 open issue
What changed in this PR

Clarifies the sorting service’s configuration API documentation for priority queues, without changing runtime behavior.

Changes:

  • Documents that getQueue() returns null for priority-queue configurations.
  • Describes getSorter() as returning a pass-through sorter because the priority queue handles ordering.
File Description
src/​main/​java/​sortingservice/​SorterConfiguration.java Updates Javadoc for priority-queue return behavior.

Review effort: Balanced

Comment on lines +49 to +50
* A configuration that uses a priority queue returns a sorter that
* returns the queue as is, since the priority queue sorts by itself.
@Bonajo
Bonajo deleted the chore/postpone-radix-sorter branch November 19, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants