Jun 23, 2009

A Generic Way To Create a Collection

How many times do you find yourself creating this code over and over again in tests or even production code?
List<String> stringList = new ArrayList<String>();
stringList.add("some test string");
stringList.add("some other test string");
aMethodThatTakesAListOfStrings(stringList);

Rather than writing this same code over and over again, there is an easier way to create a simple generic list of objects in one method. The following method makes use of two Java 5 features: variable list arguments and generics. Here’s what it looks like:
public static <E> List<E> createArrayList(final E... values) {
   final List<E> list = new ArrayList<E>(values.length);
   for (final E value : values) {
      list.add(value);
   }
   return list;
}

Let me break down what’s happening here.

public static <E> List<E>
this creates a static method and declaring E as a generic type that this method will use and returns a list of that type.

createArrayList(final E... values)
Here a variable length argument array of any type is passed in and “E” is typed to what is passed in. For example if String were passed in, E would be then typed to an array of String, or if BigDecimal were passed in, E would be typed to an array of BigDecimal (The JVM treats variable length arguments as arrays).   Anywhere there is an E, this gets typed to whatever is passed in.

In the rest of the method, an ArrayList of E is created and then the array is looped over and each type is added to the list and the list is then returned.  Here’s the same code as above using our new method:

aMethodThatTakesAListOfStrings(createArrayList("some test string", "some other test string"));

Much nicer isn’t it? That can be used with any object too such as:

aMethodThatTakesAListOfIntegers(createArrayList(1, 2, 3));

The same can be done with any other collection type such as Set, SortedSet, etc. and makes testing and writing code much eaiser.

About the Author

Object Partners profile.

One thought on “A Generic Way To Create a Collection

  1. George says:

    If you don’t mind that the list is read-only (for example parameters to a function) you can use the built in java.util.Arrays class:

    List stringList = Arrays.asList(“s1”, “s2”, “s3”);
    List intList = Arrays.asList(1, 2, 3, 4, 5, 6);

    If you use this a lot you can statically import the ‘asList’ method to clean up your code

Leave a Reply

Your email address will not be published. Required fields are marked *

Related Blog Posts
Designing Kubernetes Controllers
There has been some excellent online discussion lately around Kubernetes controllers, highlighted by an excellent Speakerdeck presentation assembled by Tim Hockin. What I’d like to do in this post is explore some of the implications […]
React Server Components
The React Team recently announced new work they are doing on React Server Components, a new way of rendering React components. The goal is to create smaller bundle sizes, speed up render time, and prevent […]
Jolt custom java transform
Jolt is a JSON to JSON transformation library where the transform is defined in JSON. It’s really good at reorganizing the json data and massaging it into the output JSON you need. Sometimes, you just […]
Page Object Model for UI Testing