Page History

The Java compiler type-checks the arguments to each variable arity (varargs) method to ensure that the arguments are of the same type or object reference. However, the compile-time checking is ineffective when Object or generic T parameter types are used [Bloch 2008]. (Note that it does not matter if there are initial parameters of specific types, the compiler will still not be able to check Object or generic T vararg variable arity parameter types.) A requirement for providing strong compile-time type checking of variable argument methods is to be as specific as possible when declaring the type of the method parameter.

Noncompliant Code Example (Object)

This noncompliant code example declares a vararg variable arity method using Object. It accepts an arbitrary mix of parameters of any object type. Legitimate uses of such declarations are rare . (See but see under "ExceptionsAppicability" below).

ReturnType method(Object... args) { }

Noncompliant Code Example (Generic Type)

This noncompliant code example declares a vararg variable arity method using a generic type parameter. It accepts a variable number of parameters that are all of the same object type. Again, legitimate uses of such declarations are rare.

<T> ReturnType method(T... args) { }

Compliant Solution

Be as specific as possible when declaring parameter types; avoid Object and imprecise generic types in varargsvariable arity methods.

ReturnType method(SpecificObjectType... args) { }

Retrofitting old methods containing final array parameters with generically typed varargs variable arity parameters is not always a good idea. For example, given a method that does not accept an argument of a particular type, it could be possible to override the compile-time checking — through the use of generic varargs variable arity parameters — so that the method would compile cleanly rather than correctly, causing a compile-time error [Bloch 2008].

Also, note that autoboxing does not allow strong compile-time type checking of primitive types and their corresponding wrapper classes.

Exceptions

Applicability

Injudicious use of variable arity parameter types prevents strong compile-time type checking, creates ambiguity, and diminishes code readability.

Variable arity DCL60-EX0: Varargs signatures using Object and imprecise generic types are acceptable when the body of the method does not use casts or autoboxing and compiles without error. Consider the following example, which operates correctly for all object types and type-checks successfully.

Collection<T> assembleCollection(T... args) {
  Collection<T> result = new HashSet<T>();
  // add each argument to the result collection
  return result;
}

DCL60-EX1: In some circumstances, it is necessary to use a vararg variable arity parameter of type Object.  A good example of this is the method java.util.Formatter.format(String format, Object... args) which can format objects of any type.

Risk Assessment

Injudicious use of varargs parameter types prevents strong compile-time type checking, creates ambiguity, and diminishes code readability.

...

Guideline

...

...

Likelihood

...

Remediation Cost

...

Priority

...

Level

...

DCL60-JG

...

low

...

unlikely

...

medium

...

P2

...

L3

Automated

...

Automated detection appears to be straightforward.

Bibliography

DCL59-JG. Avoid ambiguous overloading of variable arity methods      01. Declarations and Initialization (DCL)      DCL58-JG. Do not derive a value associated with an enum from its ordinal

...