vavr-io/vavr

(Collection) factory methods

Open

#2125 opened on Oct 8, 2017

View on GitHub
 (2 comments) (4 reactions) (0 assignees)Java (5,390 stars) (605 forks)batch import
!BACK-COMPATdesign/refactoring/improvementhelp wanted«vavr-collection»

Description

We have too many methods called of. Because most collections are also functions, I want to simplify that.

  • of(T), of(T...)
  • ofAll(Iterable)
  • ofAll(Iterator) <-- this one might be needed because Iterator (and the upcoming TraversableOnce) will not be Iterable anymore

We need to take a look if ofXyz(Xyz) or fromXyz(Xyz) makes more sense, e.g.

  • fromEntries(j.u.Map.Entry...)
  • fromEntries(Iterable<? extends j.u.Map.Entry>)
  • etc.

Also we will have distinguished factory method names that will not build instances directly from the given method parameters (like of(T...) does for example).

  • Stream.iterate(seed, f)
  • Tree.recurse(seed, f)
  • ...

Contributor guide

Tech stack
java
Domain
api
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Java 8+Familiarity with vavr collection API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
First, review the current usage of 'of' methods across all collection classes in vavr (e.g., List, Set, Map, Stream, etc.). Assess the impact of renaming and ensure consistency. Consider the naming conventions proposed (ofXyz vs fromXyz) and gather community feedback from the existing comments. Evaluate if any methods rely on the 'of' name for Java compatibility. Create a migration plan and update documentation accordingly.