• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

var args constructors/methods vs lists

 
Sergio Castro
Greenhorn
Posts: 2
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
In the long debate of using arrays vs lists in the public API of Java classes, I tend to prefer lists in most situations.
However, I also found convenient to use var arguments in many constructors and methods, which require declaring an argument of the method as an array (implicitly adding "..." before the parameter name).
Since in many of these methods I do want to provide a programmer the possibility to either explicitly list the arguments (with var args) or use a pre-defined collection when invoking the method, I often end up defining a constructor or method with var arguments, and an overloaded version that accepts a list instead of the var args array. For example:



I know that in theory I do not need to overload the method replacing the var args array with a list if I want the programmer to send a collection of objects. He could just send an array.
The reason I often do this is because most (if not all) of the methods in my API use lists instead of arrays, and it is a bit weird that for one or two methods requirying collection of objects, the programmer needs to work with arrays (in cases when the var args are not convenient).
So I provide an overloaded version working with list for consistency.

However, since this is a recurrent problem, I have the uncomfortable feeling of being writing boilerplate code too often. I would like to receive feedback if my motivation of keeping my interface consistent (accepting var arrays or lists, but not forcing the programmer to work with arrays if not really required) is valid enough to keep writing overloaded versions using lists for most of my methods requirying var arguments.
I want to highlight that I know that for certain methods arrays could be more convenient than lists. My question concerns situations where the only motivation for declaring the last argument of the method as an array is because in certain scenarios using var arguments can be convinient.
 
Rob Spoor
Sheriff
Pie
Posts: 20369
44
Chrome Eclipse IDE Java Windows
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If you want to use Lists, there are two ways you can still use the benefits of varargs:

1) Create the varargs constructor / method but make it call the List one, using Arrays.asList:

2) Create only the List version and use Arrays.asList whenever you want to use varargs.
 
Sergio Castro
Greenhorn
Posts: 2
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Rob Spoor wrote:If you want to use Lists, there are two ways you can still use the benefits of varargs:

1) Create the varargs constructor / method but make it call the List one, using Arrays.asList:

2) Create only the List version and use Arrays.asList whenever you want to use varargs.


This is what I do right now, I just clarified the question. Thanks !
This is rather a design question where I am wondering if the work of adding an overloaded method accepting a list is worthy the effort just to keep consistency. This has been bothering me since quite some time ago, given that it is a quite recurrent situation I face.
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic