Top Description Methods
org.jboss.logging.annotations

public @Interface ResolutionDoc

extends Annotation
Annotations
@Target:METHOD, TYPE
@Retention:CLASS
@Documented
Static Imports
java.lang.annotation.ElementType.METHOD, .ElementType.TYPE, .RetentionPolicy.CLASS

Allows a link to be created for messages on a report which contain a possible resolution to the issue reported . If the method does not include an id no link will be created for the report unless a path() is defined.

The rules for building the URL are as follows:

If placed on a type links will be created for all methods on the type.

Do note that the processor does not validate the resolution document exists. It simply attempts to create links to the resolution document.

Expressions in the form of ${property.key:default-value} can be used for the values with the exception of the skip attribute. If the property key is prefixed with sys. a system property will be used. If the key is prefixed with env. an environment variable will be used. In all other cases the org.jboss.logging.tools.expressionProperties processor argument is used to specify the path the properties file which contains the values for the expressions.

Author
James R. Perkins
Since
1.2

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the path to the resolution document
path
()

The path to the resolution document.

public boolean

Returns:

true if creating the link should be skipped
skip
()

Allows the creation of a link to be skipped.

public String

Returns:

the suffix for the resolution document
suffix
()

The suffix to append to the path.

public String

Returns:

the URL or an empty string
url
()

The URL, fully qualified or relative, to use for the resolution document.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

pathback to summary
public String path()

The path to the resolution document. If left undefined this will default to the message id.

Returns:String

the path to the resolution document

skipback to summary
public boolean skip()

Allows the creation of a link to be skipped.

Returns:boolean

true if creating the link should be skipped

suffixback to summary
public String suffix()

The suffix to append to the path. If left undefined this will default to the extension for the report type. For example if the report type is xml the default suffix would be .xml.

Returns:String

the suffix for the resolution document

urlback to summary
public String url()

The URL, fully qualified or relative, to use for the resolution document. If defined this will override the value of the BaseUrl if the annotation is used.

Returns:String

the URL or an empty string