• 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>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_35) on Tue Oct 09 17:08:17 PDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<TITLE>
8JsonSerializableSchema (jackson-databind 2.1.0 API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-10-09">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="JsonSerializableSchema (jackson-databind 2.1.0 API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JsonSerializableSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
49  </TR>
50</TABLE>
51</TD>
52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53</EM>
54</TD>
55</TR>
56
57<TR>
58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" title="class in com.fasterxml.jackson.databind.jsonschema"><B>PREV CLASS</B></A>&nbsp;
60&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/SchemaAware.html" title="interface in com.fasterxml.jackson.databind.jsonschema"><B>NEXT CLASS</B></A></FONT></TD>
61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62  <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" target="_top"><B>FRAMES</B></A>  &nbsp;
63&nbsp;<A HREF="JsonSerializableSchema.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
64&nbsp;<SCRIPT type="text/javascript">
65  <!--
66  if(window==top) {
67    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68  }
69  //-->
70</SCRIPT>
71<NOSCRIPT>
72  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
73</NOSCRIPT>
74
75
76</FONT></TD>
77</TR>
78<TR>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80  SUMMARY:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
83</TR>
84</TABLE>
85<A NAME="skip-navbar_top"></A>
86<!-- ========= END OF TOP NAVBAR ========= -->
87
88<HR>
89<!-- ======== START OF CLASS DATA ======== -->
90<H2>
91<FONT SIZE="-1">
92com.fasterxml.jackson.databind.jsonschema</FONT>
93<BR>
94Annotation Type JsonSerializableSchema</H2>
95<HR>
96<DL>
97<DT><PRE><FONT SIZE="-1"><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</A>)
98<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>)
99</FONT>public @interface <B>JsonSerializableSchema</B></DL>
100</PRE>
101
102<P>
103Annotation that can be used to define JSON Schema definition for
104 the annotated class.
105<p>
106 Note that annotation is often not needed: for example, regular
107 Jackson beans that Jackson can introspect can be used without
108 annotations, to produce JSON schema definition.
109<P>
110
111<P>
112<DL>
113<DT><B>Author:</B></DT>
114  <DD>Ryan Heaton, Tatu Saloranta</DD>
115</DL>
116<HR>
117
118<P>
119<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
120
121<A NAME="annotation_type_optional_element_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Optional Element Summary</B></FONT></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>&nbsp;<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></CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#id()">id</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Property that can be used to indicate id of the type when
134 generating JSON Schema; empty String indicates that no id
135 is defined.</TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;<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></CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaItemDefinition()">schemaItemDefinition</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>(since 2.1) -- support will be dropped in future, since JSON-as-String is
144   fundamentally bad way for customizing anything. No direct replacements offered.</I></TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;<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></CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaObjectPropertiesDefinition()">schemaObjectPropertiesDefinition</A></B></CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>(since 2.1) -- support will be dropped in future, since JSON-as-String is
153   fundamentally bad way for customizing anything. No direct replacements offered.</I></TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;<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></CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaType()">schemaType</A></B></CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The schema type for this JsonSerializable instance.</TD>
162</TR>
163</TABLE>
164&nbsp;
165<P>
166<A NAME="id()"><!-- --></A><H3>
167id</H3>
168<PRE>
169public abstract <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> <B>id</B></PRE>
170<DL>
171<DD>Property that can be used to indicate id of the type when
172 generating JSON Schema; empty String indicates that no id
173 is defined.
174<P>
175<DD><DL>
176</DL>
177</DD>
178<DD><DL>
179</DL>
180<DL>
181<DT><B>Default:</B><DD>""</DD>
182</DL>
183</DL>
184<HR>
185
186<A NAME="schemaType()"><!-- --></A><H3>
187schemaType</H3>
188<PRE>
189public abstract <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> <B>schemaType</B></PRE>
190<DL>
191<DD>The schema type for this JsonSerializable instance.
192 Possible values: "string", "number", "boolean", "object", "array", "null", "any"
193<P>
194<DD><DL>
195</DL>
196</DD>
197<DD><DL>
198
199<DT><B>Returns:</B><DD>The schema type for this JsonSerializable instance.</DL>
200<DL>
201<DT><B>Default:</B><DD>"any"</DD>
202</DL>
203</DL>
204<HR>
205
206<A NAME="schemaObjectPropertiesDefinition()"><!-- --></A><H3>
207schemaObjectPropertiesDefinition</H3>
208<PRE>
209<FONT SIZE="-1"><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
210</FONT>public abstract <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> <B>schemaObjectPropertiesDefinition</B></PRE>
211<DL>
212<DD><B>Deprecated.</B>&nbsp;<I>(since 2.1) -- support will be dropped in future, since JSON-as-String is
213   fundamentally bad way for customizing anything. No direct replacements offered.</I>
214<P>
215<DD>If the schema type is "object", JSON definition of properties of the object as
216 a String.
217<P>
218<DD><DL>
219</DL>
220</DD>
221<DD><DL>
222
223<DT><B>Returns:</B><DD>The node representing the schema properties, or "##irrelevant" if irrelevant.</DL>
224<DL>
225<DT><B>Default:</B><DD>"##irrelevant"</DD>
226</DL>
227</DL>
228<HR>
229
230<A NAME="schemaItemDefinition()"><!-- --></A><H3>
231schemaItemDefinition</H3>
232<PRE>
233<FONT SIZE="-1"><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
234</FONT>public abstract <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> <B>schemaItemDefinition</B></PRE>
235<DL>
236<DD><B>Deprecated.</B>&nbsp;<I>(since 2.1) -- support will be dropped in future, since JSON-as-String is
237   fundamentally bad way for customizing anything. No direct replacements offered.</I>
238<P>
239<DD>If the schema type if "array", JSON definition of the schema for item types contained.
240<P>
241<DD><DL>
242</DL>
243</DD>
244<DD><DL>
245
246<DT><B>Returns:</B><DD>The schema for the items in the array, or "##irrelevant" if irrelevant.</DL>
247<DL>
248<DT><B>Default:</B><DD>"##irrelevant"</DD>
249</DL>
250</DL>
251<!-- ========= END OF CLASS DATA ========= -->
252<HR>
253
254
255<!-- ======= START OF BOTTOM NAVBAR ====== -->
256<A NAME="navbar_bottom"><!-- --></A>
257<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
258<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
259<TR>
260<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
261<A NAME="navbar_bottom_firstrow"><!-- --></A>
262<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
263  <TR ALIGN="center" VALIGN="top">
264  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
266  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
267  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JsonSerializableSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
268  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
269  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
270  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
271  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
272  </TR>
273</TABLE>
274</TD>
275<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
276</EM>
277</TD>
278</TR>
279
280<TR>
281<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
282&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" title="class in com.fasterxml.jackson.databind.jsonschema"><B>PREV CLASS</B></A>&nbsp;
283&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/SchemaAware.html" title="interface in com.fasterxml.jackson.databind.jsonschema"><B>NEXT CLASS</B></A></FONT></TD>
284<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
285  <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" target="_top"><B>FRAMES</B></A>  &nbsp;
286&nbsp;<A HREF="JsonSerializableSchema.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
287&nbsp;<SCRIPT type="text/javascript">
288  <!--
289  if(window==top) {
290    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
291  }
292  //-->
293</SCRIPT>
294<NOSCRIPT>
295  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
296</NOSCRIPT>
297
298
299</FONT></TD>
300</TR>
301<TR>
302<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
303  SUMMARY:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
304<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
305DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
306</TR>
307</TABLE>
308<A NAME="skip-navbar_bottom"></A>
309<!-- ======== END OF BOTTOM NAVBAR ======= -->
310
311<HR>
312Copyright &#169; 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.
313</BODY>
314</HTML>
315