• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 (version 1.7.0_10-ea) on Sun Jul 14 20:03:32 PDT 2013 -->
6<title>Annotations (Jackson JSON Processor)</title>
7<meta name="date" content="2013-07-14">
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="Annotations (Jackson JSON Processor)";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/Annotations.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../../index-all.html">Index</a></li>
34<li><a href="../../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li>Prev Class</li>
40<li><a href="../../../../org/codehaus/jackson/jaxrs/JacksonJaxbJsonProvider.html" title="class in org.codehaus.jackson.jaxrs"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?org/codehaus/jackson/jaxrs/Annotations.html" target="_top">Frames</a></li>
44<li><a href="Annotations.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
66<li>Field&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
72<li>Field&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">org.codehaus.jackson.jaxrs</div>
83<h2 title="Enum Annotations" class="title">Enum Annotations</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
88<li>
89<ul class="inheritance">
90<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a>&gt;</li>
91<li>
92<ul class="inheritance">
93<li>org.codehaus.jackson.jaxrs.Annotations</li>
94</ul>
95</li>
96</ul>
97</li>
98</ul>
99<div class="description">
100<ul class="blockList">
101<li class="blockList">
102<dl>
103<dt>All Implemented Interfaces:</dt>
104<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a>&gt;</dd>
105</dl>
106<hr>
107<br>
108<pre>public enum <span class="strong">Annotations</span>
109extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a>&gt;</pre>
110<div class="block">Enumeration that defines standard annotation sets available for configuring
111 data binding aspects.</div>
112</li>
113</ul>
114</div>
115<div class="summary">
116<ul class="blockList">
117<li class="blockList">
118<!-- =========== ENUM CONSTANT SUMMARY =========== -->
119<ul class="blockList">
120<li class="blockList"><a name="enum_constant_summary">
121<!--   -->
122</a>
123<h3>Enum Constant Summary</h3>
124<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
125<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
126<tr>
127<th class="colOne" scope="col">Enum Constant and Description</th>
128</tr>
129<tr class="altColor">
130<td class="colOne"><code><strong><a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html#JACKSON">JACKSON</a></strong></code>
131<div class="block">Standard Jackson annotations, defined in Jackson core and mapper
132 packages</div>
133</td>
134</tr>
135<tr class="rowColor">
136<td class="colOne"><code><strong><a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html#JAXB">JAXB</a></strong></code>
137<div class="block">Standard JAXB annotations, used in a way that approximates expected
138 definitions (since JAXB defines XML aspects, not all features map
139 well to JSON handling)</div>
140</td>
141</tr>
142</table>
143</li>
144</ul>
145<!-- ========== METHOD SUMMARY =========== -->
146<ul class="blockList">
147<li class="blockList"><a name="method_summary">
148<!--   -->
149</a>
150<h3>Method Summary</h3>
151<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
152<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
153<tr>
154<th class="colFirst" scope="col">Modifier and Type</th>
155<th class="colLast" scope="col">Method and Description</th>
156</tr>
157<tr class="altColor">
158<td class="colFirst"><code>static <a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a></code></td>
159<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
160<div class="block">Returns the enum constant of this type with the specified name.</div>
161</td>
162</tr>
163<tr class="rowColor">
164<td class="colFirst"><code>static <a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a>[]</code></td>
165<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html#values()">values</a></strong>()</code>
166<div class="block">Returns an array containing the constants of this enum type, in
167the order they are declared.</div>
168</td>
169</tr>
170</table>
171<ul class="blockList">
172<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
173<!--   -->
174</a>
175<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
176<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li>
177</ul>
178<ul class="blockList">
179<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
180<!--   -->
181</a>
182<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
183<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
184</ul>
185</li>
186</ul>
187</li>
188</ul>
189</div>
190<div class="details">
191<ul class="blockList">
192<li class="blockList">
193<!-- ============ ENUM CONSTANT DETAIL =========== -->
194<ul class="blockList">
195<li class="blockList"><a name="enum_constant_detail">
196<!--   -->
197</a>
198<h3>Enum Constant Detail</h3>
199<a name="JACKSON">
200<!--   -->
201</a>
202<ul class="blockList">
203<li class="blockList">
204<h4>JACKSON</h4>
205<pre>public static final&nbsp;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a> JACKSON</pre>
206<div class="block">Standard Jackson annotations, defined in Jackson core and mapper
207 packages</div>
208</li>
209</ul>
210<a name="JAXB">
211<!--   -->
212</a>
213<ul class="blockListLast">
214<li class="blockList">
215<h4>JAXB</h4>
216<pre>public static final&nbsp;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a> JAXB</pre>
217<div class="block">Standard JAXB annotations, used in a way that approximates expected
218 definitions (since JAXB defines XML aspects, not all features map
219 well to JSON handling)</div>
220</li>
221</ul>
222</li>
223</ul>
224<!-- ============ METHOD DETAIL ========== -->
225<ul class="blockList">
226<li class="blockList"><a name="method_detail">
227<!--   -->
228</a>
229<h3>Method Detail</h3>
230<a name="values()">
231<!--   -->
232</a>
233<ul class="blockList">
234<li class="blockList">
235<h4>values</h4>
236<pre>public static&nbsp;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a>[]&nbsp;values()</pre>
237<div class="block">Returns an array containing the constants of this enum type, in
238the order they are declared.  This method may be used to iterate
239over the constants as follows:
240<pre>
241for (Annotations c : Annotations.values())
242&nbsp;   System.out.println(c);
243</pre></div>
244<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
245the order they are declared</dd></dl>
246</li>
247</ul>
248<a name="valueOf(java.lang.String)">
249<!--   -->
250</a>
251<ul class="blockListLast">
252<li class="blockList">
253<h4>valueOf</h4>
254<pre>public static&nbsp;<a href="../../../../org/codehaus/jackson/jaxrs/Annotations.html" title="enum in org.codehaus.jackson.jaxrs">Annotations</a>&nbsp;valueOf(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
255<div class="block">Returns the enum constant of this type with the specified name.
256The string must match <i>exactly</i> an identifier used to declare an
257enum constant in this type.  (Extraneous whitespace characters are
258not permitted.)</div>
259<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
260<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
261<dt><span class="strong">Throws:</span></dt>
262<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant
263with the specified name</dd>
264<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl>
265</li>
266</ul>
267</li>
268</ul>
269</li>
270</ul>
271</div>
272</div>
273<!-- ========= END OF CLASS DATA ========= -->
274<!-- ======= START OF BOTTOM NAVBAR ====== -->
275<div class="bottomNav"><a name="navbar_bottom">
276<!--   -->
277</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
278<!--   -->
279</a>
280<ul class="navList" title="Navigation">
281<li><a href="../../../../overview-summary.html">Overview</a></li>
282<li><a href="package-summary.html">Package</a></li>
283<li class="navBarCell1Rev">Class</li>
284<li><a href="class-use/Annotations.html">Use</a></li>
285<li><a href="package-tree.html">Tree</a></li>
286<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
287<li><a href="../../../../index-all.html">Index</a></li>
288<li><a href="../../../../help-doc.html">Help</a></li>
289</ul>
290</div>
291<div class="subNav">
292<ul class="navList">
293<li>Prev Class</li>
294<li><a href="../../../../org/codehaus/jackson/jaxrs/JacksonJaxbJsonProvider.html" title="class in org.codehaus.jackson.jaxrs"><span class="strong">Next Class</span></a></li>
295</ul>
296<ul class="navList">
297<li><a href="../../../../index.html?org/codehaus/jackson/jaxrs/Annotations.html" target="_top">Frames</a></li>
298<li><a href="Annotations.html" target="_top">No Frames</a></li>
299</ul>
300<ul class="navList" id="allclasses_navbar_bottom">
301<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
302</ul>
303<div>
304<script type="text/javascript"><!--
305  allClassesLink = document.getElementById("allclasses_navbar_bottom");
306  if(window==top) {
307    allClassesLink.style.display = "block";
308  }
309  else {
310    allClassesLink.style.display = "none";
311  }
312  //-->
313</script>
314</div>
315<div>
316<ul class="subNavList">
317<li>Summary:&nbsp;</li>
318<li>Nested&nbsp;|&nbsp;</li>
319<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
320<li>Field&nbsp;|&nbsp;</li>
321<li><a href="#method_summary">Method</a></li>
322</ul>
323<ul class="subNavList">
324<li>Detail:&nbsp;</li>
325<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
326<li>Field&nbsp;|&nbsp;</li>
327<li><a href="#method_detail">Method</a></li>
328</ul>
329</div>
330<a name="skip-navbar_bottom">
331<!--   -->
332</a></div>
333<!-- ======== END OF BOTTOM NAVBAR ======= -->
334</body>
335</html>
336