org.glassfish.pfl.tf.spi.annotation

Annotation Type Description

@Documented
@Target(value={METHOD,FIELD,TYPE})
@Retention(value=RUNTIME)
public @interface Description

Used to associate a description with part of a class.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The description to be applied to the annotated element.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	key Optional key to use in a resource bundle for this description.

Element Detail

value

public abstract String value

The description to be applied to the annotated element. This value must not be empty. It can either be the actual string that describes the annotated element, or a key into a resource bundle associated. If there is no bundle value associated with the key, or no resource bundle is specified, the value is used directly.

key

public abstract String key

Optional key to use in a resource bundle for this description. If present, a tool will generate a resource bundle that contains key=value taken from the description annotation.

If this key is not present, the default key is given by the class name, if this annotation appears on a class, or the class name.method name if this annotation appears on a method. It is an error to use the default value for more than one method of the same name, except for setters and getters.

Default:

""