org.jboss.logging.annotations

public @Interface FormatWith

Annotations

@Target:PARAMETER
@Retention:CLASS
@Documented

Static Imports

java.lang.annotation.ElementType.PARAMETER, .RetentionPolicy.CLASS

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

Method Summary

Modifier and Type	Method and Description
public Class<?>	Returns: the class value() The class of the formatting object to use.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

value	back to summary
public Class<?> value() The class of the formatting object to use. Returns:Class<?> the class

value

back to summary

public Class<?> value()

The class of the formatting object to use.

Returns:Class<?>: the class