Template to show method name and parameter values

Question

Is there any way to have a template (Java -> Editor -> Templates) in Eclipse that generate something like this

debug("methodName arg1=" + arg1 + " arg2=" + arg2 + " arg3=" + arg3);

When used in a method. For instance:

public void setImage(long rowId, long contactId, String thinggy) {
   // invoking the template here, produces this:
   debug("setImage rowId=" + rowId + " contactId=" + contactId + " thinggy=" + thinggy);
}

I couldn't find a way to do that with the standard template UI, maybe there exists a plugin to do this kinds of things?

Answer 1

or template=

if (aLog.isDebugEnabled()) {
  aLog.debug(String.format("${enclosing_method}:${enclosing_method_arguments}".replaceAll(", ", "=%s, ")+"=%s", ${enclosing_method_arguments}));
}

gives

public static void hesteFras(boolean connect, Object ged, String frans, int cykel) {
    if (aLog.isDebugEnabled()) {
        aLog.debug(String.format("hesteFras: connect, ged, frans, cykel".replaceAll(", ", "=%s, ") + "=%s",
                connect, ged, frans, cykel));
    }

which for

hesteFras(false, null, "sur", 89);

gives a log statement:

hesteFras: connect=false, ged=null, frans=sur, cykel=89

Answer 2

This is a start:

debug("${enclosing_method_arguments}: ", ${enclosing_method_arguments});

which produces the following:

debug("arg1, arg2, arg3: ", arg1, arg2, arg3);

I haven't found a way to separate out each argument. I found this page that ran into the same problem.

For other Eclipse template stuff, look at this question.

Answer 3

I've made small plugin that adds nicely formatted variable:

https://github.com/dernasherbrezon/eclipse-log-param

Eclipse doesnt provide any information about parameter type, so there is no Arrays.toString(...)

Answer 4

I guess it's probably a bit too late to answer this question but maybe my answer will help someone :

System.out.println(String.format("%tH:% %s", java.util.Calendar.getInstance(), "${enclosing_package}.${enclosing_type}.${enclosing_method}(${enclosing_method_arguments})"));
String[] lArgsNames = new String("${enclosing_method_arguments}").split(", ");
Object[] lArgsValues = new Object[] {${enclosing_method_arguments}};
for (int i = 0; i < lArgsValues.length; i++) {
    System.out.println("\t" + (lArgsValues[i] != null ? ("(" + lArgsValues[i].getClass().getSimpleName() + ") \"" + lArgsNames[i] + "\" = \"" + lArgsValues[i] + "\"") : "\"" + lArgsNames[i] + "\" is null"));
}

For this method :

public void foo(boolean arg){
    // ...
}

the output would be:

18:43:43:076 > any.package.AnyClass.foo(arg)
    (Boolean) "arg" = "true"

This code seems to be able to handle any object, primitive type and null value. And yes it's a little bit complicated for the purpose!

Answer 5

The eclipse-log-param plugin is useful to avoid having to type the logging line manually. However, it would be even nicer to have the line added automatically for all new methods.

Is this even possible? It looks like in Windows->Preferences->Code Style->Code Templates->Code there are ways to configure automatically added code like auto-generated methods ("Method body" template, which has an "Auto-generated method stub" comment). But there's no way to configure new methods which are not generated.

Furthermore, the variable formatted_method_parameters is not available when editing the template for "Method body".