This is a simplified version of the code in question, one generic class uses another class with generic type parameters and needs to pass one of the generic types to a method with varargs parameters:
class Assembler<X, Y> {
void assemble(X container, Y... args) { ... }
}
class Component<T> {
void useAssembler(T something) {
Assembler<String, T> assembler = new Assembler<String, T>();
//generates warning:
// Type safety : A generic array of T is
// created for a varargs parameter
assembler.assemble("hello", something);
}
}
Is there any correct way to pass along the generic parameter to a varargs method without encountering this warning?
Of course something like
assembler.assemble("hello", new T[] { something });
does not work since you cannot create generic arrays.
In Java 6, other than adding @SuppressWarnings("unchecked")
, I don't think so.
This bug report has more information but it boils down to the compiler not liking arrays of generic types.
In Java 7, annotate the method declaration with @SafeVarargs
If you're after a fluent-type interface, you could try the builder pattern. Not as concise as varargs but it is type safe.
A static generically-typed method can eliminate some of the boilerplate when using the builder, while retaining the type safety.
The builder
public class ArgBuilder<T> implements Iterable<T> {
private final List<T> args = new ArrayList<T>();
public ArgBuilder<T> and(T arg) {
args.add(arg);
return this;
}
@Override
public Iterator<T> iterator() {
return args.iterator();
}
public static <T> ArgBuilder<T> with(T firstArgument) {
return new ArgBuilder<T>().and(firstArgument);
}
}
Using it
import static com.example.ArgBuilder.*;
public class VarargsTest {
public static void main(String[] args) {
doSomething(new ArgBuilder<String>().and("foo").and("bar").and("baz"));
// or
doSomething(with("foo").and("bar").and("baz"));
}
static void doSomething(Iterable<String> args) {
for (String arg : args) {
System.out.println(arg);
}
}
}
Collection
(in this case an ArrayList
) is forced upon the caller, whereas they may know that a LinkedList
is more appropriate, or an immutable array itself (such as the varargs from the OP question). In an un-specialized use case this may be appropriate, but just pointing out that this is also a limitation, in a way, depending on the code surrounding this and your needs.
Explicitly casting parameters to Object in vararg method invocation will make the compiler happy without resorting to @SuppressWarnings.
public static <T> List<T> list( final T... items )
{
return Arrays.asList( items );
}
// This will produce a warning.
list( "1", 2, new BigDecimal( "3.5" ) )
// This will not produce a warning.
list( (Object) "1", (Object) 2, (Object) new BigDecimal( "3.5" ) )
// This will not produce a warning either. Casting just the first parameter to
// Object appears to be sufficient.
list( (Object) "1", 2, new BigDecimal( "3.5" ) )
I believe the issue here is that the compiler needs to figure out what concrete type of array to create. If the method is not generic, the compiler can use type information from the method. If the method is generic, it tries to figure out the array type based on parameters used at invocation. If the parameter types are homogenic, that task is easy. If they vary, the compiler tries to be too clever in my opinion and creates a union-type generic array. Then it feels compelled to warn you about it. A simpler solution would have been to create Object[] when type cannot be better narrowed down. The above solution forces just that.
To understand this better, play around with invocations to the above list method compared to the following list2 method.
public static List<Object> list2( final Object... items )
{
return Arrays.asList( items );
}
It is a very easy problem to solve: Use List<T>
!
Arrays of reference type should be avoided.
In the current version of Java (1.7), you can mark method with @SafeVargs
which will remove the warning from the caller. Careful with that though, and you're still better off without legacy arrays.
List.of()
provides a relatively concise way of writing an (unmodifiable) List
until Java gains an appropriate literal representation.
See also the Improved Compiler Warnings and Errors When Using Non-Reifiable Formal Parameters with Varargs Methods tech note.
List
is more useful, whereas array is a raw implementation detail.
You can add @SafeVarargs to method since Java 7, and you don't have to annotate on client code.
class Assembler<X, Y> {
@SafeVarargs
final void assemble(X container, Y... args) {
//has to be final...
}
}
You can have overload the methods. This does not solve your problem but it minimizes the number of warnings (and yes, it's a hack!)
class Assembler<X, Y> {
void assemble(X container, Y a1) { ... }
void assemble(X container, Y a1, Y a2) { ... }
void assemble(X container, Y a1, Y a2, Y a3) { ... }
void assemble(X container, Y a1, Y a2, Y a3, Y a4) { ... }
void assemble(X container, Y... args) { ... }
}
When workings with arrays of generic type, I am forced to pass a reference to the generic type. With that, I can actually do the generic code, using java.lang.reflect.Array.
http://java.sun.com/javase/6/docs/api/java/lang/reflect/Array.html
Success story sharing