Creating a Commons Collections MultiValueMap with a custom value collection type

Question

The 4.0 release of the Apache Commons Collections library has added generics support. I am having trouble converting my code to take advantage of it:

I would like a MultiValueMap which takes a String as a key, and a collection of Strings as the value. But:

The keys should retain insertion ordering (so I create the multi-valued map by decorating a LinkedHashMap)
The values should be unique for each key and retain insertion ordering (so I want the values Collection type to be a LinkedHashSet).

The closest I can get is:

MultiValueMap<String, String> orderedMap = MultiValueMap.multiValueMap(
    new LinkedHashMap<String, Collection<String>>(), 
    LinkedHashSet.class
);

But that produces the error:

The method multiValueMap(Map<K,? super C>, Class<C>) in the type MultiValueMap is not applicable for the arguments (LinkedHashMap<String,Collection<String>>, Class<LinkedHashSet>)

So now I am in generics hell. Any suggestions would be most welcome.

Prior to version 4.0, I accomplished that with the following:

MultiValueMap orderedMap = MultiValueMap.decorate(
    new LinkedHashMap<>(), 
    LinkedHashSet.class
);

Simple! I provide the LinkedHashMap to decorate with MultiValueMap behaviour, and specify the type of collection (LinkedHashSet) to use as the values. But that requires casting when I call put() and get() and so I'd like to be able to use the new generic version provided by 4.0.

score 5 · Accepted Answer · answered Apr 01 '14 at 03:20

I consulted the Apache Commons Collections mailing list, where it was explained to me that the interface for MultiValueMap is known to be lacking, but will be revamped in version 4.1 (see here for the JIRA issue and associated discussion).

So in the future we may have a better solution, but in the meantime, as Rohit Jain mentioned in his answer, we're just going to have to suppress some warnings. However, since the key aspect of type safety is for the MultiValueMap (not the custom collection type), the simplest way to achieve this is:

@SuppressWarnings({ "rawtypes", "unchecked" })
MultiValueMap<String, String> orderedMap = 
    MapUtils.multiValueMap(new LinkedHashMap(), LinkedHashSet.class);

Note the use of the MapUtils factory method, rather than the more direct MultiValueMap which I had used in my original question.

thats a shame, SetValuedMap looks like what i wanted – Kalpesh Soni Sep 09 '15 at 06:09 — Kalpesh Soni, Sep 09 '15 at 06:09

Rohit Jain · Answer 2 · 2014-03-25T04:55:07.567

1

The problem is you need to pass a Class<LinkedHashSet<String>> as second argument. That you can't create directly. You need to do some cast.

This will work fine:

@SuppressWarnings("unchecked")
MultiValueMap<String, String> orderedMap = 
           MultiValueMap.multiValueMap(
                new LinkedHashMap<String, Collection<String>>(), 
                (Class<LinkedHashSet<String>>)(Class<?>)LinkedHashSet.class
           );

edited Mar 25 '14 at 04:55

answered Mar 25 '14 at 04:44

Rohit Jain

209,639
45
409
525

Thanks for the response. I've tried it, and that certainly works. The double cast has me troubled, though. That, along with all the generic type parameters I've had to add seems to defeat my intention for using the generic version of this class in the first place - which was to simplify my code. :\ – Ryan Bennetts Mar 25 '14 at 05:00
@RyanBennetts It would certainly make your code more type safe. However, there are some corner cases like this, where you've to do such things. – Rohit Jain Mar 25 '14 at 05:10

Creating a Commons Collections MultiValueMap with a custom value collection type

2 Answers2

Linked