[jboss-jira] [JBoss JIRA] Commented: (LOGTOOL-20) Detect parameters being inconsistent with log message template

[James Perkins (JIRA)]

    [ https://issues.jboss.org/browse/LOGTOOL-20?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12608947#comment-12608947 ] 

James Perkins commented on LOGTOOL-20:
--------------------------------------

Ah, thanks. I do think I will add that. I did find the cause of the error. I was passing the invalid strings to a different String.format() and it obviously didn't have the correct number of arguments. I'm going to try to fix the error and add you change to be safe. Thanks for the help on this!

> Detect parameters being inconsistent with log message template
> --------------------------------------------------------------
>
>                 Key: LOGTOOL-20
>                 URL: https://issues.jboss.org/browse/LOGTOOL-20
>             Project: Log Tool
>          Issue Type: Feature Request
>      Security Level: Public(Everyone can see) 
>            Reporter: Sanne Grinovero
>            Assignee: James Perkins
>             Fix For: 1.0.0.Beta8
>
>
> In both Infinispan and Hibernate we had reports of issues following the same patterns, as in code like:
> {code}
> @LogMessage(level = ERROR)
> @Message(id = 21, value = "Unable to synchronize source of %s for entity %s")
> void unableToSynchronizeSource(String indexName, @Cause Exception e);
> {code}
> People might do mistakes in the string template, forget to pass enough parameters, or not use the positional _%1$s_ variants. We can hardly write tests to cover all log messages, while I think it would be quite cool if the annotation processor could verify messages consistency with parameters at compile time.
> It would be just awesome if it could check for type consistency as well.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira