Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I declare a member with multiple generic types that have non-trivial relationships?

Tags:

java

generics

Here is what I would like to write in my java code:

private <A extends Action<R>, R extends Result> MyType<A,R> member;

This is invalid syntax however. So I end up writing:

private MyType<? extends Action<? extends Result>, ? extends Result> member;

But this disregard the fact that both classes derived from Result are the same. My class methods all enforce this relationship, so I can be sure that MyType enforces it, but I still have to unsafely typecast member in some instances.

More details

Here is the precise version of what I want to do, although it is much more criptic:

I wish I could do:

private <A extends Action<R>, R extends Result> 
    Map< Class<A>, ActionHandler<A,R> > handlers;

Instead I have to do:

private Map< Class< ? extends Action<? extends Result> >, 
             ActionHandler<? extends Action<? extends Result>, 
                           ? extends Result> > handlers;

My methods enforce the desired relationship and look like that:

public <A extends Action<R>, R extends Result> void addHandler( 
    ActionHandler<A, R> handler ) {
  handlers.put( handler.getActionType(), handler );
}

I would like the following method:

public <A extends Action<R>, R extends Result> ActionHandler<A, R> 
    findHandler( A action ) {
  return handlers.get( action.getClass() );
}

But this doesn't work: I have to add a cast and a @SuppressWarnings("unchecked").

Things I tried

I tried creating a new class just for that purpose :

public class MyMap <A extends Action<R>, R extends Result> extends 
    HashMap< Class<A>, ActionHandler<A,R> > { ... }

MyMap< ?, ? > handlers;

But it didn't work, I still need a cast.

like image 484
Philippe Beaudoin Avatar asked Feb 17 '10 22:02

Philippe Beaudoin


1 Answers

There's no clean way to do this. The best you can do is what you've already done -- hide the Map behind methods that enforce type safety, and hide the necessary casts in those methods.

From Effective Java 2nd edition, Item 29: "Consider typesafe heterogeneous containers" (in which Josh Bloch sketches out a simpler version of what you're doing, a "map" where the keys are classes and the values are instances of the key class):

The next thing to notice is that the value type of the favorites Map is simply Object. In other words, the Map does not guarantee the type relationship between keys and values. In fact, Java's type system is not powerful enough to express this. But we know that it's true, and we take advantage of it when it comes time to retrieve a favorite.

Given that you can't get any useful type enforcement for the values anyway, the least messy implementation is probably something like this:

public class HandlerRegistry
{
    private Map<Class<?>, Object> map = new HashMap<Class<?>, Object>();

    public <R extends Result, A extends Action<R>>
        void addHandler(Class<A> actionClass, ActionHandler<R, A> handler) {
        map.put(actionClass, handler);
    }

    @SuppressWarnings("unchecked")
    public <R extends Result, A extends Action<R>> ActionHandler<R, A>
        findHandler(A action) {
            return (ActionHandler<R, A>) map.get(action.getClass());
    }
}

One thing to note about a Map-based solution: if action isn't exactly the class used as the key, map.get() isn't going to work -- for instance, if it's a subclass, or if the key class is an interface and the action itself is the implementation. You might be better off with:

    @SuppressWarnings("unchecked")
    public <R extends Result, A extends Action<R>> ActionHandler<R, ? super A>
        findHandler( A action ) {
            for ( Map.Entry<Class<?>, Object> entry : map.entrySet() )
            {
                if (entry.getKey().isAssignableFrom(action.getClass())) {
                    return (ActionHandler<R, ? super A>) entry.getValue();
                }
            }
            return null;
    }

(Note: Originally the second example above returned ActionHandler<R, A>, which isn't actually correct -- it should be ? super A. (We don't know what it can handle besides A -- it could be any superclass of A, all the way up to Object.) In this particular case it's probably safe enough, but if you consider something like a List, we could be in a lot of trouble: you can safely put an A into a List<? super A>, but if you assume you're only going to get As out of it, you're going to get ClassCastExceptions.)

like image 140
David Moles Avatar answered Oct 08 '22 20:10

David Moles