FormatWith (JBoss Logging I18n Documentation 2.1.0.Final API)

org.jboss.logging.annotations

## Annotation Type FormatWith

-     @Target(value=PARAMETER)
       @Retention(value=CLASS)
       @Documented
      public @interface FormatWith

  Indicate that the given parameter should be wrapped with a formatting object of the given class. The class must have a one-argument constructor which unambiguously accepts a value of this parameter's type. The resultant object will be passed in as a parameter to the underlying format type; thus its `toString()` method will be invoked (or, if the format style is `PRINTF`, the object may implement `Formattable` to get extra functionality).
  Author:
    David M. Lloyd

- - ### Required Element Summary

    Required Elements
    Modifier and Type | Required Element and Description
    --- | ---
    `Class<?>` | `value` The class of the formatting object to use.

- - ### Element Detail

    - #### value

          public abstract Class<?> value

      The class of the formatting object to use.
      Returns:
        the class

Copyright © 2017 JBoss by Red Hat. All rights reserved.