Debian Codegraph @

docs/apidocs/index-all.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc -->
6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <title>Index (JBoss Logging I18n Documentation 2.2.1.Final API)</title>
8 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9 <script type="text/javascript" src="script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Index (JBoss Logging I18n Documentation 2.2.1.Final API)";
16 }
17 }
18 catch(err) {
19 }
20 //-->
21 </script>
22 <noscript>
23 <div>JavaScript is disabled on your browser.</div>
24 </noscript>
25 <!-- ========= START OF TOP NAVBAR ======= -->
26 <div class="topNav"><a name="navbar.top">
27 <!-- -->
28 </a>
29 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
30 <a name="navbar.top.firstrow">
31 <!-- -->
32 </a>
33 <ul class="navList" title="Navigation">
34 <li><a href="org/jboss/logging/annotations/package-summary.html">Package</a></li>
35 <li>Class</li>
36 <li>Use</li>
37 <li><a href="org/jboss/logging/annotations/package-tree.html">Tree</a></li>
38 <li><a href="deprecated-list.html">Deprecated</a></li>
39 <li class="navBarCell1Rev">Index</li>
40 <li><a href="help-doc.html">Help</a></li>
41 </ul>
42 <div class="aboutLanguage">JBoss Logging Tools, 2.2.1.Final</div>
43 </div>
44 <div class="subNav">
45 <ul class="navList">
46 <li>Prev</li>
47 <li>Next</li>
48 </ul>
49 <ul class="navList">
50 <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
51 <li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
52 </ul>
53 <ul class="navList" id="allclasses_navbar_top">
54 <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
55 </ul>
56 <div>
57 <script type="text/javascript"><!--
58 allClassesLink = document.getElementById("allclasses_navbar_top");
59 if(window==top) {
60 allClassesLink.style.display = "block";
61 }
62 else {
63 allClassesLink.style.display = "none";
64 }
65 //-->
66 </script>
67 </div>
68 <a name="skip.navbar.top">
69 <!-- -->
70 </a></div>
71 <!-- ========= END OF TOP NAVBAR ========= -->
72 <div class="contentContainer"><a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a name="I:B">
73 <!-- -->
74 </a>
75 <h2 class="title">B</h2>
76 <dl>
77 <dt><a href="org/jboss/logging/annotations/BaseUrl.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">BaseUrl</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
78 <dd>
79 <div class="block">Messages on reports can have a link to a <a href="org/jboss/logging/annotations/ResolutionDoc.html" title="annotation in org.jboss.logging.annotations">resolution document</a>.</div>
80 </dd>
81 </dl>
82 <a name="I:C">
83 <!-- -->
84 </a>
85 <h2 class="title">C</h2>
86 <dl>
87 <dt><a href="org/jboss/logging/annotations/Cause.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Cause</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
88 <dd>
89 <div class="block">Mark a parameter as being the "exception cause" parameter rather than a positional format parameter.</div>
90 </dd>
91 <dt><a href="org/jboss/logging/annotations/ConstructType.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">ConstructType</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
92 <dd>
93 <div class="block">Indicates the value of this annotation should be constructed and returned.</div>
94 </dd>
95 </dl>
96 <a name="I:F">
97 <!-- -->
98 </a>
99 <h2 class="title">F</h2>
100 <dl>
101 <dt><a href="org/jboss/logging/annotations/Field.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Field</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
102 <dd>
103 <div class="block">Indicate that a method parameter value should be applied to a field on the resultant exception object.</div>
104 </dd>
105 <dt><a href="org/jboss/logging/annotations/Fields.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Fields</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
106 <dd>
107 <div class="block">Defines the default field properties to use on the resultant exception object.</div>
108 </dd>
109 <dt><a href="org/jboss/logging/annotations/FormatWith.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">FormatWith</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
110 <dd>
111 <div class="block">Indicate that the given parameter should be wrapped with a formatting object of the given class.</div>
112 </dd>
113 </dl>
114 <a name="I:I">
115 <!-- -->
116 </a>
117 <h2 class="title">I</h2>
118 <dl>
119 <dt><span class="memberNameLink"><a href="org/jboss/logging/annotations/Message.html#INHERIT">INHERIT</a></span> - Static variable in annotation type org.jboss.logging.annotations.<a href="org/jboss/logging/annotations/Message.html" title="annotation in org.jboss.logging.annotations">Message</a></dt>
120 <dd>
121 <div class="block">Indicates that this message should inherit the ID from another message with the same name.</div>
122 </dd>
123 </dl>
124 <a name="I:L">
125 <!-- -->
126 </a>
127 <h2 class="title">L</h2>
128 <dl>
129 <dt><a href="org/jboss/logging/annotations/LoggingClass.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">LoggingClass</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
130 <dd>
131 <div class="block">Mark a parameter as specifying the name of the logging class to use.</div>
132 </dd>
133 <dt><a href="org/jboss/logging/annotations/LogMessage.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">LogMessage</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
134 <dd>
135 <div class="block">A typed logger method.</div>
136 </dd>
137 </dl>
138 <a name="I:M">
139 <!-- -->
140 </a>
141 <h2 class="title">M</h2>
142 <dl>
143 <dt><a href="org/jboss/logging/annotations/Message.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Message</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
144 <dd>
145 <div class="block">Assigns a message string to a resource method.</div>
146 </dd>
147 <dt><a href="org/jboss/logging/annotations/Message.Format.html" title="enum in org.jboss.logging.annotations"><span class="typeNameLink">Message.Format</span></a> - Enum in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
148 <dd>
149 <div class="block">The possible format types.</div>
150 </dd>
151 <dt><a href="org/jboss/logging/annotations/MessageBundle.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">MessageBundle</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
152 <dd>
153 <div class="block">Signify that an interface is a message bundle interface.</div>
154 </dd>
155 <dt><a href="org/jboss/logging/annotations/MessageLogger.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">MessageLogger</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
156 <dd>
157 <div class="block">Signify that an interface is a typed logger interface.</div>
158 </dd>
159 </dl>
160 <a name="I:N">
161 <!-- -->
162 </a>
163 <h2 class="title">N</h2>
164 <dl>
165 <dt><span class="memberNameLink"><a href="org/jboss/logging/annotations/Message.html#NONE">NONE</a></span> - Static variable in annotation type org.jboss.logging.annotations.<a href="org/jboss/logging/annotations/Message.html" title="annotation in org.jboss.logging.annotations">Message</a></dt>
166 <dd>
167 <div class="block">Indicates that this message has no ID.</div>
168 </dd>
169 </dl>
170 <a name="I:O">
171 <!-- -->
172 </a>
173 <h2 class="title">O</h2>
174 <dl>
175 <dt><a href="org/jboss/logging/annotations/Once.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Once</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
176 <dd>
177 <div class="block">Indicates a message should only be logged once.</div>
178 </dd>
179 <dt><a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a> - package org.jboss.logging.annotations</dt>
180 <dd>&nbsp;</dd>
181 </dl>
182 <a name="I:P">
183 <!-- -->
184 </a>
185 <h2 class="title">P</h2>
186 <dl>
187 <dt><a href="org/jboss/logging/annotations/Param.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Param</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
188 <dd>
189 <div class="block">Identifies a parameter is to be used for constructing an exception and excluded from the formatting of the message.</div>
190 </dd>
191 <dt><a href="org/jboss/logging/annotations/Pos.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Pos</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
192 <dd>&nbsp;</dd>
193 <dt><a href="org/jboss/logging/annotations/Producer.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Producer</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
194 <dd>
195 <div class="block">Identifies a parameter has the ability to produce a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><code>Throwable</code></a> or a super type of a <code>Throwable</code>.</div>
196 </dd>
197 <dt><a href="org/jboss/logging/annotations/Properties.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Properties</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
198 <dd>
199 <div class="block">Defines the default properties to use on the resultant exception object.</div>
200 </dd>
201 <dt><a href="org/jboss/logging/annotations/Property.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Property</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
202 <dd>
203 <div class="block">Indicate that a method parameter value should be applied to a property (with a setter method) on the resultant
204 exception object.</div>
205 </dd>
206 </dl>
207 <a name="I:R">
208 <!-- -->
209 </a>
210 <h2 class="title">R</h2>
211 <dl>
212 <dt><a href="org/jboss/logging/annotations/ResolutionDoc.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">ResolutionDoc</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
213 <dd>
214 <div class="block">Allows a link to be created for messages on a report which contain a possible resolution to the issue reported .</div>
215 </dd>
216 </dl>
217 <a name="I:S">
218 <!-- -->
219 </a>
220 <h2 class="title">S</h2>
221 <dl>
222 <dt><a href="org/jboss/logging/annotations/Signature.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Signature</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
223 <dd>
224 <div class="block">Specifies the exact signature to use when creating a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><code>Throwable</code></a> return type.</div>
225 </dd>
226 <dt><a href="org/jboss/logging/annotations/Suppressed.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Suppressed</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
227 <dd>
228 <div class="block">Indicates the parameter should be added as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">suppressed</a> exception to
229 the returned exception.</div>
230 </dd>
231 </dl>
232 <a name="I:T">
233 <!-- -->
234 </a>
235 <h2 class="title">T</h2>
236 <dl>
237 <dt><a href="org/jboss/logging/annotations/Transform.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">Transform</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
238 <dd>
239 <div class="block">Indicate the given parameter should be transformed in each of the <a href="org/jboss/logging/annotations/Transform.TransformType.html" title="enum in org.jboss.logging.annotations"><code>transform types</code></a>
240 provided.</div>
241 </dd>
242 <dt><a href="org/jboss/logging/annotations/Transform.TransformType.html" title="enum in org.jboss.logging.annotations"><span class="typeNameLink">Transform.TransformType</span></a> - Enum in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
243 <dd>
244 <div class="block">The transform type</div>
245 </dd>
246 </dl>
247 <a name="I:V">
248 <!-- -->
249 </a>
250 <h2 class="title">V</h2>
251 <dl>
252 <dt><a href="org/jboss/logging/annotations/ValidIdRange.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">ValidIdRange</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
253 <dd>
254 <div class="block">Sets a range of valid id's allowed on the <a href="org/jboss/logging/annotations/Message.html#id--"><code>message id</code></a>.</div>
255 </dd>
256 <dt><a href="org/jboss/logging/annotations/ValidIdRanges.html" title="annotation in org.jboss.logging.annotations"><span class="typeNameLink">ValidIdRanges</span></a> - Annotation Type in <a href="org/jboss/logging/annotations/package-summary.html">org.jboss.logging.annotations</a></dt>
257 <dd>&nbsp;</dd>
258 <dt><span class="memberNameLink"><a href="org/jboss/logging/annotations/Message.Format.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.jboss.logging.annotations.<a href="org/jboss/logging/annotations/Message.Format.html" title="enum in org.jboss.logging.annotations">Message.Format</a></dt>
259 <dd>
260 <div class="block">Returns the enum constant of this type with the specified name.</div>
261 </dd>
262 <dt><span class="memberNameLink"><a href="org/jboss/logging/annotations/Transform.TransformType.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.jboss.logging.annotations.<a href="org/jboss/logging/annotations/Transform.TransformType.html" title="enum in org.jboss.logging.annotations">Transform.TransformType</a></dt>
263 <dd>
264 <div class="block">Returns the enum constant of this type with the specified name.</div>
265 </dd>
266 <dt><span class="memberNameLink"><a href="org/jboss/logging/annotations/Message.Format.html#values--">values()</a></span> - Static method in enum org.jboss.logging.annotations.<a href="org/jboss/logging/annotations/Message.Format.html" title="enum in org.jboss.logging.annotations">Message.Format</a></dt>
267 <dd>
268 <div class="block">Returns an array containing the constants of this enum type, in
269 the order they are declared.</div>
270 </dd>
271 <dt><span class="memberNameLink"><a href="org/jboss/logging/annotations/Transform.TransformType.html#values--">values()</a></span> - Static method in enum org.jboss.logging.annotations.<a href="org/jboss/logging/annotations/Transform.TransformType.html" title="enum in org.jboss.logging.annotations">Transform.TransformType</a></dt>
272 <dd>
273 <div class="block">Returns an array containing the constants of this enum type, in
274 the order they are declared.</div>
275 </dd>
276 </dl>
277 <a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;</div>
278 <!-- ======= START OF BOTTOM NAVBAR ====== -->
279 <div class="bottomNav"><a name="navbar.bottom">
280 <!-- -->
281 </a>
282 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
283 <a name="navbar.bottom.firstrow">
284 <!-- -->
285 </a>
286 <ul class="navList" title="Navigation">
287 <li><a href="org/jboss/logging/annotations/package-summary.html">Package</a></li>
288 <li>Class</li>
289 <li>Use</li>
290 <li><a href="org/jboss/logging/annotations/package-tree.html">Tree</a></li>
291 <li><a href="deprecated-list.html">Deprecated</a></li>
292 <li class="navBarCell1Rev">Index</li>
293 <li><a href="help-doc.html">Help</a></li>
294 </ul>
295 <div class="aboutLanguage">JBoss Logging Tools, 2.2.1.Final</div>
296 </div>
297 <div class="subNav">
298 <ul class="navList">
299 <li>Prev</li>
300 <li>Next</li>
301 </ul>
302 <ul class="navList">
303 <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
304 <li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
305 </ul>
306 <ul class="navList" id="allclasses_navbar_bottom">
307 <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
308 </ul>
309 <div>
310 <script type="text/javascript"><!--
311 allClassesLink = document.getElementById("allclasses_navbar_bottom");
312 if(window==top) {
313 allClassesLink.style.display = "block";
314 }
315 else {
316 allClassesLink.style.display = "none";
317 }
318 //-->
319 </script>
320 </div>
321 <a name="skip.navbar.bottom">
322 <!-- -->
323 </a></div>
324 <!-- ======== END OF BOTTOM NAVBAR ======= -->
325 <p class="legalCopy"><small>Copyright &#169; 2019 <a href="http://www.jboss.org">JBoss by Red Hat</a>. All rights reserved.</small></p>
326 </body>
327 </html>