1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ResolutionDoc (JBoss Logging I18n Documentation 2.2.1.Final API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ResolutionDoc (JBoss Logging I18n Documentation 2.2.1.Final API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/jboss/logging/annotations/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ResolutionDoc.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">JBoss Logging Tools, 2.2.1.Final</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/jboss/logging/annotations/Property.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/jboss/logging/annotations/Signature.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jboss/logging/annotations/ResolutionDoc.html" target="_top">Frames</a></li>
<li><a href="ResolutionDoc.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Field | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jboss.logging.annotations</div>
<h2 title="Annotation Type ResolutionDoc" class="title">Annotation Type ResolutionDoc</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>})
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#CLASS" title="class or interface in java.lang.annotation">CLASS</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a>
public @interface <span class="memberNameLabel">ResolutionDoc</span></pre>
<div class="block">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 <a href="../../../../org/jboss/logging/annotations/Message.html#id--">id</a> no link will be created for the report unless a
<a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#path--"><code>path()</code></a> is defined.
<p>
The rules for building the URL are as follows:
<ul>
<li><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#url--"><code>url</code></a>: If left empty and the type is annotated with a <a href="../../../../org/jboss/logging/annotations/BaseUrl.html" title="annotation in org.jboss.logging.annotations"><code>BaseUrl</code></a> the value for the
<code>@BaseUrl</code> will be used. If defined this will override the value of the <a href="../../../../org/jboss/logging/annotations/BaseUrl.html" title="annotation in org.jboss.logging.annotations"><code>BaseUrl</code></a>. If neither are
defined the rules for the <a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#path--"><code>path()</code></a> will be followed.</li>
<li><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#path--"><code>path</code></a>: If defined this will be the path appended to the <a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#url--"><code>url()</code></a> or the value of the
<a href="../../../../org/jboss/logging/annotations/BaseUrl.html" title="annotation in org.jboss.logging.annotations"><code>BaseUrl</code></a>. Note that neither <a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#url--"><code>url()</code></a> nor <a href="../../../../org/jboss/logging/annotations/BaseUrl.html" title="annotation in org.jboss.logging.annotations"><code>BaseUrl</code></a> are required. If the value is left
undefined the id (project code plus the <a href="../../../../org/jboss/logging/annotations/Message.html#id--">message id</a>) will be used for the path.</li>
<li><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#suffix--"><code>suffix</code></a>: The suffix to append to the <a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#path--"><code>path()</code></a>. This is mostly useful if the path
is left undefined and a suffix should be appended to the messages id. If left undefined and the <a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#path--"><code>path()</code></a>
is not defined, the suffix will be determined based on the report type.</li>
</ul>
</p>
<p>
If placed on a type links will be created for all methods on the type.
</p>
<p>
Do note that the processor does not validate the resolution document exists. It simply attempts to create links to
the resolution document.
</p>
<p>
Expressions in the form of <code>${property.key:default-value}</code> can be used for the values with the exception of the
<a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#skip--"><code>skip</code></a> attribute. If the property key is prefixed with <code>sys.</code> a
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#getProperty-java.lang.String-" title="class or interface in java.lang">system property</a> will be used. If the key is prefixed with <code>env.</code> an
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#getenv-java.lang.String-" title="class or interface in java.lang">environment variable</a> will be used. In all other cases the
<code>org.jboss.logging.tools.expressionProperties</code> processor argument is used to specify the path the properties
file which contains the values for the expressions.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:jperkins@redhat.com">James R. Perkins</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#path--">path</a></span></code>
<div class="block">The path to the resolution document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#skip--">skip</a></span></code>
<div class="block">Allows the creation of a link to be skipped.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#suffix--">suffix</a></span></code>
<div class="block">The suffix to append to the path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jboss/logging/annotations/ResolutionDoc.html#url--">url</a></span></code>
<div class="block">The URL, fully qualified or relative, to use for the resolution document.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="url--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>url</h4>
<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url</pre>
<div class="block">The URL, fully qualified or relative, to use for the resolution document. If defined this will override the value
of the <a href="../../../../org/jboss/logging/annotations/BaseUrl.html" title="annotation in org.jboss.logging.annotations"><code>BaseUrl</code></a> if the annotation is used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URL or an empty string</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="path--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>path</h4>
<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path</pre>
<div class="block">The path to the resolution document. If left undefined this will default to the message id.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the path to the resolution document</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="suffix--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suffix</h4>
<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix</pre>
<div class="block">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 <code>xml</code> the default suffix would be <code>.xml</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the suffix for the resolution document</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="skip--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>skip</h4>
<pre>public abstract boolean skip</pre>
<div class="block">Allows the creation of a link to be skipped.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if creating the link should be skipped</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/jboss/logging/annotations/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ResolutionDoc.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">JBoss Logging Tools, 2.2.1.Final</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/jboss/logging/annotations/Property.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/jboss/logging/annotations/Signature.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jboss/logging/annotations/ResolutionDoc.html" target="_top">Frames</a></li>
<li><a href="ResolutionDoc.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Field | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2019 <a href="http://www.jboss.org">JBoss by Red Hat</a>. All rights reserved.</small></p>
</body>
</html>
|
